svn commit: r1802941 - /subversion/trunk/subversion/svn/svn.c

[st...@apache.org]

Author: stsp
Date: Tue Jul 25 13:53:31 2017
New Revision: 1802941

URL: http://svn.apache.org/viewvc?rev=1802941&view=rev
Log:
Tweak the help text for 'svn cleanup'.

Mention in the summary that unversioned and ignores items can be deleted.

Split the syntax into two usage: variants, one with option and one without.
Suggested-by: julianfoad
I saw no good way of putting all the long options on one line, so the usage
string just says "OPTIONS".

Clarify that the command is only unsafe if none of the mode options are given.

* subversion/svn/svn.c
  (svn_cl__cmd_table): Adjust cleanup help text.

Modified:
    subversion/trunk/subversion/svn/svn.c

Modified: subversion/trunk/subversion/svn/svn.c
URL: http://svn.apache.org/viewvc/subversion/trunk/subversion/svn/svn.c?rev=1802941&r1=1802940&r2=1802941&view=diff
==============================================================================
--- subversion/trunk/subversion/svn/svn.c (original)
+++ subversion/trunk/subversion/svn/svn.c Tue Jul 25 13:53:31 2017
@@ -610,8 +610,9 @@ const svn_opt_subcommand_desc2_t svn_cl_
 
   { "cleanup", svn_cl__cleanup, {0}, N_
     ("Recursively clean up the working copy, removing write locks, resuming\n"
-     "unfinished operations, etc.\n"
-     "usage: cleanup [WCPATH...]\n"
+     "unfinished operations, removing unversioned or ignored items, etc.\n"
+     "usage: 1. cleanup [WCPATH...]\n"
+     "usage: 2. cleanup OPTIONS [WCPATH...]\n"
      "\n"
      "  By default, finish any unfinished business in the working copy at WCPATH,\n"
      "  and remove write locks (shown as 'L' by the 'svn status' command) from\n"
@@ -620,8 +621,8 @@ const svn_opt_subcommand_desc2_t svn_cl_
      "\n"
      "  WARNING: There is no mechanism that will protect write locks still\n"
      "           being used by other Subversion clients. Running this command\n"
-     "           while another client is using the working copy can corrupt\n"
-     "           the working copy beyond repair!\n"
+     "           without any options while another client is using the working\n"
+     "           copy can corrupt the working copy beyond repair!\n"
      "\n"
      "  If the --remove-unversioned option or the --remove-ignored option\n"
      "  is given, remove any unversioned or ignored items within WCPATH.\n"