git/list[1] front-page[2] threads[3] people[4] search[5] about
 

git-log: documenting pathspec usage

From
Adam Spiers <git@adamspiers.org>
Date
Nov 16, 2020, 12:22 UTC
Message-ID
<20201116122230.eyizwe2bmqkmftch@gmail.com>
Hi all,
I just noticed that git-log.txt has: 
     SYNOPSIS
     --------
     [verse]
     'git log' [<options>] [<revision range>] [[--] <path>...]
and builtin/log.c has: 
     static const char * const builtin_log_usage[] = {
             N_("git log [<options>] [<revision-range>] [[--] <path>...]"),

IIUC, the references to <path> should actually be <pathspec> instead, as seen with other pathspec-supporting commands such as git add/rm whose man pages are extra helpful in explicitly calling out how pathspecs can be used, e.g.:

     OPTIONS
     -------
     <pathspec>...::
             Files to add content from.  Fileglobs (e.g. `*.c`) can
             be given to add all matching files.  Also a
             leading directory name (e.g. `dir` to add `dir/file1`
             and `dir/file2`) can be given to update the index to
             match the current state of the directory as a whole (e.g.
             specifying `dir` will record not just a file `dir/file1`
             modified in the working tree, a file `dir/file2` added to
             the working tree, but also a file `dir/file3` removed from
             the working tree). Note that older versions of Git used
             to ignore removed files; use `--no-all` option if you want
             to add modified or new files but ignore removed ones.
     +
     For more details about the <pathspec> syntax, see the 'pathspec' entry
     in linkgit:gitglossary[7].

Would it be fair to say the git-log usage syntax and man page should be updated to match? If so perhaps I can volunteer for that.

Regards, Adam

Next: Ævar Arnfjörð Bjarmason
Message 1 of 4 in “git-log: documenting pathspec usage”
  1. Adam SpiersNov 16, 2020
  2. Ævar Arnfjörð BjarmasonNov 16, 2020
  3. Philippe BlainNov 16, 2020
  4. Junio C HamanoNov 16, 2020

Read the whole thread, see it on lore, or plain text.

$ cat FOOTERMessages come from the public archive at lore.kernel.org/git, fetched every hour. The front page is chosen and written each morning by an AI editor and can be wrong; the threads themselves are the record. About and API. For agents: an MCP server at https://gitlist.dev/mcp, and any thread, story or person page as Markdown by adding .md to its URL (or sending Accept: text/markdown). Details in /llms.txt.