Add documentation for cred store common values #157
Conversation
docs/source/credstore.rst
Outdated
| Common Values for Credentials Store Extensions | ||
| ============================================== | ||
|
|
||
| .. py:module:: gssapi.raw |
There was a problem hiding this comment.
this isn't the gssapi.raw module
There was a problem hiding this comment.
what is it ?
sphinx complains if there is no module
docs/source/index.rst
Outdated
| @@ -28,6 +28,7 @@ straight into the :doc:`high-level API documentation <gssapi>`. | |||
|
|
|||
| gssapi.rst | |||
| gssapi.raw.rst | |||
| credstore.rst | |||
There was a problem hiding this comment.
I'd add an extra level of indirection in the ToC, like we do for tutorials. So maybe Implementation-Specific Tips and Documentation, and then list the Cred Store stuff under that
docs/source/credstore.rst
Outdated
| :func:`gssapi.raw.ext_cred_store.add_cred_from` functions, to indicate a | ||
| custom location for a keytab containing client keys. | ||
| It is not used in the context of calls used to store credentials. | ||
| The value is a string in the form "type:residual" where type can be any |
There was a problem hiding this comment.
the word residual is a bit unclear here. Maybe something like
type:config, where config is some type-specific configuration. For instance, for theFILEtype,configis a path, likeFILE:/tmp/my.keytab
There was a problem hiding this comment.
residual is the technical name as found in MIT docs, at most I can use "path" if you think residual is to be avoided.
There was a problem hiding this comment.
maybe put in in parens or something. It's non-obvious to most people that haven't already read the MIT docs, but it's good to have it there for people who have.
|
@DirectXMan12 PTAL |
|
@DirectXMan12 ping ? |
|
responded to the |
frozencemetery
force-pushed
the
credstoredoc
branch
from
d6f650b to
8c682df
Compare
Signed-off-by: Simo Sorce <[email protected]>
Add docs to explain what cred store values can be used and how