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

Re: [PATCHv5/RFC 3/6] gitweb: Add manpage for gitweb (APPLICATION!!!)

From
Drew Northup <drew.northup@maine.edu>
Date
Oct 11, 2011, 16:56 UTC
Message-ID
<1318352213.22324.58.camel@drew-northup.unet.maine.edu>
In-Reply-To
<201110111620.12788.jnareb@gmail.com>
On Tue, 2011-10-11 at 16:20 +0200, Jakub Narebski wrote:
Show 33 quoted lines
> On Tue, 11 Oct 2011, Drew Northup wrote:
> > On Tue, 2011-10-11 at 15:51 +0200, Jakub Narebski wrote:
> > > On Tue, 11 Oct 2011, Drew Northup wrote:
> > 
> > > > This would be why I included a synopsis with my original submission. As
> > > > this was supposed to be a description of the configuration files of said
> > > > application it does not make much sense to put the executable in the
> > > > synopsis. Please forgive me for attempting to make sense!
> > > 
> > > But this manpage is about _gitweb itself_, not about gitweb config file(s).
> > > Gitweb itself is application, though it is not runnable directly (yet).
> > > 
> > > Web apps either don't use manpages as documentation, and those that do
> > > that I found (SVN::Web for example) include runnable server-starting script.
> > 
> > Hmm, Couldn't tell from the mail header _which_ we were talking about in
> > this subthread. I'll have to read the _whole_ patch apparently next
> > time.
> 
> I'm sorry.  I guess better subjects would be:
> 
>   gitweb: Add gitweb.conf(5) manpage
>   gitweb: Add gitweb(1) manpage
> 
> instead of current
> 
>   gitweb: Add manpage for gitweb configuration files
>   gitweb: Add manpage for gitweb
> 
> Or perhaps:
> 
>   gitweb: Add manpage for gitweb configuration files
>   gitweb: Add manpage for gitweb itself

Jakub, For the sake of clarity I'd go with redundancy (but I've noticed that's not always enormously popular around here)

	gitweb: Add manpage for gitweb configuration files--gitweb.conf(5)
	gitweb: Add manpage for gitweb itself--gitweb(1)

Perhaps the first one is too long, but I think that it leaves little question as to what the patch contains. Otherwise, your first or final pair of updated subjects would probably be clear enough.

Granted, just as soon as you fix that somebody else will manage to top my misreading of the subject line ;-).

-- 
-Drew Northup
________________________________________________
"As opposed to vegetable or mineral error?"
-John Pescatore, SANS NewsBites Vol. 12 Num. 59
Previous: Jakub NarebskiNext: Jakub Narebski
Message 18 of 22 in “[PATCHv5/RFC 0/6] Moving gitweb documentation to manpages”
  1. Jakub NarebskiOct 8, 2011
  2. 1/6 Documentation: Preparation for gitweb manpagesJakub Narebski, Oct 8, 2011
  3. Junio C HamanoOct 10, 2011
  4. Jakub NarebskiOct 10, 2011
  5. Junio C HamanoOct 10, 2011
  6. Jakub NarebskiOct 11, 2011
  7. Junio C HamanoOct 11, 2011
  8. Jakub NarebskiOct 11, 2011
  9. 2/6 gitweb: Add manpage for gitweb configuration filesJakub Narebski, Oct 8, 2011
  10. 3/6 gitweb: Add manpage for gitwebJakub Narebski, Oct 8, 2011
  11. Junio C HamanoOct 10, 2011
  12. Jakub NarebskiOct 10, 2011
  13. Jonathan NiederOct 10, 2011
  14. Drew NorthupOct 11, 2011
  15. Jakub NarebskiOct 11, 2011
  16. Drew NorthupOct 11, 2011
  17. Jakub NarebskiOct 11, 2011
  18. Drew NorthupOct 11, 2011
  19. 4/6 Documentation: Link to gitweb(1) and gitweb.conf(5) in other manpagesJakub Narebski, Oct 8, 2011
  20. 5/6 Documentation: Add gitweb config variables to git-config(1)Jakub Narebski, Oct 8, 2011
  21. 6/6 gitweb: Add gitweb manpages to 'gitweb' package in git.specJakub Narebski, Oct 8, 2011
  22. Junio C HamanoOct 10, 2011

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.