unofficial mirror of bug-gnu-emacs@gnu.org 
 help / color / mirror / code / Atom feed
From: Eli Zaretskii <eliz@gnu.org>
To: Juri Linkov <juri@linkov.net>
Cc: 63690@debbugs.gnu.org
Subject: bug#63690: 29.0.91; New vc commands missing on vc-menu
Date: Wed, 24 May 2023 21:39:48 +0300	[thread overview]
Message-ID: <83ttw1mv4b.fsf@gnu.org> (raw)
In-Reply-To: <86cz2pzlee.fsf@mail.linkov.net> (message from Juri Linkov on Wed, 24 May 2023 20:31:21 +0300)

> From: Juri Linkov <juri@linkov.net>
> Cc: 63690@debbugs.gnu.org
> Date: Wed, 24 May 2023 20:31:21 +0300
> 
> >> @@ -898,6 +927,15 @@ vc-menu-map
> >> +    (bindings--define-key map [vc-print-branch-log]
> >> +      '(menu-item "Show Branch History" vc-print-branch-log
> >> +		  :help "Show the change log for branch root"))
> >
> > What is "branch root"?
> 
> Probably better to drop the word "root" to e.g.:
> 
>   "List the change log for branch"

This prompts for the branch to log, right?  Then the menu item should
ends in a "...", and the help text should be

   "List the change log for a branch"

> Then docstring of 'vc-print-branch-log' could be changed too.

Yes, and it should say that the command prompts for the branch to log.

> >> +    (bindings--define-key map [vc-switch-branch]
> >> +      '(menu-item "Switch Branch" vc-switch-branch
> >> +		  :help "Switch to the branch"))
> >
> > "the" branch?
> 
> Maybe "the selected branch".

I think

  "Switch to another branch"

> Then it may need an ellipsis:
> "Switch Branch..."

Yes.

> > Also, AFAICT these commands are not described in the manual.  If they
> > are important enough to be on the menu bar, I think we should mention
> > them in the manual as well, no?
> 
> They are mentioned briefly in
> 
>   (info "(emacs) Creating Branches")
>   (info "(emacs) Switching Branches")
>   (info "(emacs) Editing VC Commands")

Mentioned, but not indexed.  Please always index every command
described in the manual, both its name and its key binding (if any).
This is necessary to allow users to find the description of each
command quickly and easily.

Also, vc-print-branch-log is not really described, it's just used in
an unrelated example of using a different feature.





  reply	other threads:[~2023-05-24 18:39 UTC|newest]

Thread overview: 7+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2023-05-24 16:16 bug#63690: 29.0.91; New vc commands missing on vc-menu Juri Linkov
2023-05-24 16:51 ` Eli Zaretskii
2023-05-24 17:31   ` Juri Linkov
2023-05-24 18:39     ` Eli Zaretskii [this message]
2023-05-25  6:43       ` Juri Linkov
2023-05-25  7:50         ` Eli Zaretskii
2023-05-25 18:25           ` Juri Linkov

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

  List information: https://www.gnu.org/software/emacs/

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=83ttw1mv4b.fsf@gnu.org \
    --to=eliz@gnu.org \
    --cc=63690@debbugs.gnu.org \
    --cc=juri@linkov.net \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
Code repositories for project(s) associated with this public inbox

	https://git.savannah.gnu.org/cgit/emacs.git

This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for read-only IMAP folder(s) and NNTP newsgroup(s).