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

Re: [PATCHv5/RFC 3/6] gitweb: Add manpage for gitweb

From
Jakub Narebski <jnareb@gmail.com>
Date
Oct 11, 2011, 13:51 UTC
Message-ID
<201110111551.09621.jnareb@gmail.com>
In-Reply-To
<1318338135.22324.33.camel@drew-northup.unet.maine.edu>
On Tue, 11 Oct 2011, Drew Northup wrote:
Show 28 quoted lines
> On Mon, 2011-10-10 at 17:18 -0500, Jonathan Nieder wrote:
> > Jakub Narebski wrote:
> > 
> > > The problem is that catering to old AsciiDoc (but still used by some of
> > > long-term-support Linux distributions) requires to have "SYNOPSIS"
> > > section... but there is no natural synopsis for non self-hostable web
> > > application, is there?
> > 
> > I personally think something like
> > 
> > 	SYNOPSIS
> > 	--------
> > 	/usr/share/gitweb/gitweb.cgi
> > 	git instaweb
> > 
> > or perhaps something like
> > 
> > 	SYNOPSIS
> > 	--------
> > 	http://<site>/?p=<project>.git;a=<action>;h=<object>;<parameters>
> > 	http://<site>/<project>/<action>/<object>?<parameters>
> > 
> > would be best.
> 
> 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.

-- 
Jakub Narebski
Poland
Previous: Drew NorthupNext: Drew Northup
Message 15 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.