You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@subversion.apache.org by ju...@apache.org on 2018/11/21 15:11:12 UTC
svn commit: r1847117 - /subversion/trunk/subversion/libsvn_subr/config_file.c
Author: julianfoad
Date: Wed Nov 21 15:11:12 2018
New Revision: 1847117
URL: http://svn.apache.org/viewvc?rev=1847117&view=rev
Log:
Improve documentation of 'store-*' options in the 'servers' config file.
* subversion/libsvn_subr/config_file.c
(svn_config_ensure): In the docs for the various 'store-*' options in
the 'servers' config file:
- clarify that each option refers to *new* credentials (previously
mentioned in a following note);
- deduplicate and so make consistent the notes about deleting stored
credentials;
- mention as first choice the new 'svn auth --remove' way of doing this;
- refer to a more directly relevant section of the book;
- put the book URL all on one (over-long) line to improve its usability.
Modified:
subversion/trunk/subversion/libsvn_subr/config_file.c
Modified: subversion/trunk/subversion/libsvn_subr/config_file.c
URL: http://svn.apache.org/viewvc/subversion/trunk/subversion/libsvn_subr/config_file.c?rev=1847117&r1=1847116&r2=1847117&view=diff
==============================================================================
--- subversion/trunk/subversion/libsvn_subr/config_file.c (original)
+++ subversion/trunk/subversion/libsvn_subr/config_file.c Wed Nov 21 15:11:12 2018
@@ -1192,16 +1192,13 @@ svn_config_ensure(const char *config_dir
"### may be cached to disk." NL
"### username Specifies the default username." NL
"###" NL
- "### Set store-passwords to 'no' to avoid storing passwords on disk" NL
- "### in any way, including in password stores. It defaults to" NL
+ "### Set store-passwords to 'no' to avoid storing new passwords on" NL
+ "### disk in any way, including in password stores. It defaults to" NL
"### 'yes', but Subversion will never save your password to disk in" NL
"### plaintext unless explicitly configured to do so." NL
- "### Note that this option only prevents saving of *new* passwords;" NL
- "### it doesn't invalidate existing passwords. (To do that, remove" NL
- "### the cache files by hand as described in the Subversion book.)" NL
"###" NL
#ifndef SVN_DISABLE_PLAINTEXT_PASSWORD_STORAGE
- "### Set store-plaintext-passwords to 'no' to avoid storing" NL
+ "### Set store-plaintext-passwords to 'no' to avoid storing new" NL
"### passwords in unencrypted form in the auth/ area of your config" NL
"### directory. Set it to 'yes' to allow Subversion to store" NL
"### unencrypted passwords in the auth/ area. The default is" NL
@@ -1211,22 +1208,15 @@ svn_config_ensure(const char *config_dir
"### 'store-auth-creds' is set to 'no'." NL
"###" NL
#endif
- "### Set store-ssl-client-cert-pp to 'no' to avoid storing ssl" NL
+ "### Set store-ssl-client-cert-pp to 'no' to avoid storing new ssl" NL
"### client certificate passphrases in the auth/ area of your" NL
"### config directory. It defaults to 'yes', but Subversion will" NL
"### never save your passphrase to disk in plaintext unless" NL
"### explicitly configured to do so." NL
"###" NL
- "### Note store-ssl-client-cert-pp only prevents the saving of *new*"NL
- "### passphrases; it doesn't invalidate existing passphrases. To do"NL
- "### that, remove the cache files by hand as described in the" NL
- "### Subversion book at http://svnbook.red-bean.com/nightly/en/\\" NL
- "### svn.serverconfig.netmodel.html\\" NL
- "### #svn.serverconfig.netmodel.credcache" NL
- "###" NL
#ifndef SVN_DISABLE_PLAINTEXT_PASSWORD_STORAGE
"### Set store-ssl-client-cert-pp-plaintext to 'no' to avoid storing"NL
- "### passphrases in unencrypted form in the auth/ area of your" NL
+ "### new passphrases in unencrypted form in the auth/ area of your" NL
"### config directory. Set it to 'yes' to allow Subversion to" NL
"### store unencrypted passphrases in the auth/ area. The default" NL
"### is 'ask', which means that Subversion will prompt before" NL
@@ -1235,12 +1225,19 @@ svn_config_ensure(const char *config_dir
"### 'store-ssl-client-cert-pp' is set to 'no'." NL
"###" NL
#endif
- "### Set store-auth-creds to 'no' to avoid storing any Subversion" NL
+ "### Set store-auth-creds to 'no' to avoid storing any new Subversion"
+ NL
"### credentials in the auth/ area of your config directory." NL
"### Note that this includes SSL server certificates." NL
- "### It defaults to 'yes'. Note that this option only prevents" NL
- "### saving of *new* credentials; it doesn't invalidate existing" NL
- "### caches. (To do that, remove the cache files by hand.)" NL
+ "### It defaults to 'yes'." NL
+ "###" NL
+ "### Note that setting a 'store-*' option to 'no' only prevents" NL
+ "### saving of *new* passwords, passphrases or other credentials." NL
+ "### It does not remove or invalidate existing stored credentials." NL
+ "### To do that, see the 'svn auth --remove' command, or remove the" NL
+ "### cache files by hand as described in the Subversion book at" NL
+ "### http://svnbook.red-bean.com/nightly/en/svn.serverconfig.netmodel.html#svn.tour.initial.authn-cache-purge"
+ NL
"###" NL
"### HTTP timeouts, if given, are specified in seconds. A timeout" NL
"### of 0, i.e. zero, causes a builtin default to be used." NL