[svn.haxx.se] · SVN Dev · SVN Users · SVN Org · TSVN Dev · TSVN Users · Subclipse Dev · Subclipse Users · this month's index

Re: bikeshed: output of 'svn help mergeinfo'

From: Karl Fogel <kfogel_at_red-bean.com>
Date: Sun, 04 May 2008 19:00:45 -0400

"Ben Collins-Sussman" <sussman_at_red-bean.com> writes:
> I'm busy updating chapter 4 in the book to match svn-1.5-rc5.
>
> I have two tiny suggestions for the help text of svn mergeinfo:
>
> [...]

Good ideas. Am testing the patch below now; will commit after I find
out whether any getopt_tests need to be adjusted.

[[[
* subversion/svn/main.c
  (svn_cl__cmd_table."mergeinfo"): Change doc string to be more about
    results and less about implementation, and to specify the default
    value of TARGET.

Suggested by: sussman

See also http://khaki.bikeshed.com/, or this mail:

   http://subversion.tigris.org/servlets/ReadMsg?list=dev&msgNo=138165
   From: "Ben Collins-Sussman" <sussman_at_red-bean.com>
   To: "Subversion Developers" <dev_at_subversion.tigris.org>
   Subject: bikeshed: output of 'svn help mergeinfo'
   Date: Sun, 4 May 2008 15:14:39 -0500
   Message-ID: <53c059c90805041314i4a07b2e8ifd47436a8c9254a8_at_mail.gmail.com>
]]]

Index: subversion/svn/main.c
===================================================================
--- subversion/svn/main.c (revision 31019)
+++ subversion/svn/main.c (working copy)
@@ -625,14 +625,14 @@
      opt_record_only, 'x', opt_ignore_ancestry, opt_accept, opt_reintegrate} },
 
   { "mergeinfo", svn_cl__mergeinfo, {0}, N_
- ("Query merge-related information.\n"
+ ("Display merge-related information.\n"
      "usage: mergeinfo SOURCE-URL[@REV] [TARGET[@REV]]\n"
      "\n"
- " Query information related to merges (or potential merges) between\n"
- " SOURCE-URL and TARGET. If the --show-revs option is not provided,\n"
- " display revisions which have been merged from SOURCE-URL to TARGET.\n"
- " Otherwise, display the type of information specified by the\n"
- " --show-revs option.\n"),
+ " Display information related to merges (or potential merges) between\n"
+ " SOURCE-URL and TARGET (default: '.'). If the --show-revs option\n"
+ " is not provided, display revisions which have been merged from\n"
+ " SOURCE-URL to TARGET; otherwise, display the type of information\n"
+ " specified by the --show-revs option.\n"),
     {'r', opt_show_revs} },
 
   { "mkdir", svn_cl__mkdir, {0}, N_

> ---------
> mergeinfo: Query merge-related information.
> usage: mergeinfo SOURCE-URL[@REV] [TARGET[@REV]]
>
> Query information related to merges (or potential merges) between
> SOURCE-URL and TARGET. If the --show-revs option is not provided,
> display revisions which have been merged from SOURCE-URL to TARGET.
> Otherwise, display the type of information specified by the
> --show-revs option.
> ----------
>
> First, I think the two uses of the word 'query' should be changed to
> 'display' or 'show'. "Querying" is what the user is already doing
> when she types the command; the command might be querying a merge-db
> somewhere internally, but what's important is what it will do for the
> user -- display information about merges.
>
> Second, this help text gives no explanation of what TARGET defaults
> to. I assume it defaults to URL of '.' or something?
>
> ---------------------------------------------------------------------
> To unsubscribe, e-mail: dev-unsubscribe_at_subversion.tigris.org
> For additional commands, e-mail: dev-help_at_subversion.tigris.org

---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe_at_subversion.tigris.org
For additional commands, e-mail: dev-help_at_subversion.tigris.org
Received on 2008-05-05 01:00:58 CEST

This is an archived mail posted to the Subversion Dev mailing list.