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

[RFC/PATCHv3 0/5] Improving gitweb documentation, creating manpages

From
Jakub Narebski <jnareb@gmail.com>
Date
Jun 6, 2011, 17:44 UTC
Message-ID
<1307382271-7677-1-git-send-email-jnareb@gmail.com>
This is yet a work in progress.
0. The first three patches are improvements to gitweb's INSTALL and
README files, before moving or copying most of the contents to
gitweb.txt and gitweb.conf.txt i.e. newly introduced gitweb's
manpages.
The first two were sent to git mailing list as
  [PATCH 0/2] Improving gitweb documentation
  http://thread.gmane.org/gmane.comp.version-control.git/174954
Third one was sent as reply in thread mentioned above
  [PATCH 3/2] gitweb: Move "Requirements" up in gitweb/INSTALL
  http://thread.gmane.org/gmane.comp.version-control.git/174954/focus=175016
1. The man page for /etc/gitweb.conf is modified, extended and
improved version of patch by Drew Northup from
  "[PATCH/WIP] Starting work on a man page for /etc/gitweb.conf"
  http://thread.gmane.org/gmane.comp.version-control.git/173422

Drew version was mostly pulled directly from the README and INSTALL files of gitweb. I have tried to incorporate comments in mentioned thread, and to group config variables by category.

This version now moves, rather than copies, contents from gitweb/README file.

2. The man page for gitweb is slightly extended version of patch I
have sent to git mailing list as
  "[RFC/PATCH] gitweb: Starting work on a man page for gitweb (WIP)"
  http://thread.gmane.org/gmane.comp.version-control.git/173422/focus=173625

This version now moves, rather than copies, contents from gitweb/README and gitweb/INSTALL files.

......................................................................

The part that is left is turn references to chapters/sections into hyperlinks, fix and unify AsciiDoc formatting (it is quite inconsistent now), checking for leftover unintended duplication, cleaning up gitweb/README.

NOTE also that I have only tested that both generated manpages _looks_ (halfway) reasonable. I didn't check HTML output.

Those commits also available in 'gitweb/doc' branch in both of my repositories:

  git://repo.or.cz/git/jnareb-git.git
  git://github.com/jnareb/git.git
Shortlog:
~~~~~~~~~
Drew Northup (1):
  gitweb: Starting work on a man page for /etc/gitweb.conf (WIP)

The one that started this. Drew, could you comment on this thread? Thanks in advance.

Jakub Narebski (4):
  gitweb: Move information about installation from README to INSTALL
  gitweb: Describe CSSMIN and JSMIN in gitweb/INSTALL
  gitweb: Move "Requirements" up in gitweb/INSTALL
  gitweb: Starting work on a man page for gitweb (WIP)
My contributions.
Table of contents:
~~~~~~~~~~~~~~~~~~
 [PATCHv3 1/5] gitweb: Move information about installation from
 [PATCHv3 2/5] gitweb: Describe CSSMIN and JSMIN in gitweb/INSTALL
 [PATCHv3 3/5] gitweb: Move "Requirements" up in gitweb/INSTALL
 [RFC/PATCHv3 4/5] gitweb: Starting work on a man page for /etc/gitweb.conf (WIP)
 [RFC/PATCHv3 5/5] gitweb: Starting work on a man page for gitweb (WIP)
Diffstat:
~~~~~~~~~
 Documentation/Makefile        |    9 +-
 Documentation/gitweb.conf.txt |  724 +++++++++++++++++++++++++++++++++++++++++
 Documentation/gitweb.txt      |  702 +++++++++++++++++++++++++++++++++++++++
 gitweb/INSTALL                |  246 ++++++++------
 gitweb/Makefile               |    7 +-
 gitweb/README                 |  519 +----------------------------
 6 files changed, 1599 insertions(+), 608 deletions(-)
 create mode 100644 Documentation/gitweb.conf.txt
 create mode 100644 Documentation/gitweb.txt
Dirstat:
~~~~~~~~
  62.4% Documentation/
  37.5% gitweb/
-- 
1.7.5
Next: Jakub Narebski
Message 1 of 23 in “[RFC/PATCHv3 0/5] Improving gitweb documentation, creating manpages”
  1. Jakub NarebskiJun 6, 2011
  2. 1/5 gitweb: Move information about installation from README to INSTALLJakub Narebski, Jun 6, 2011
  3. Jonathan NiederJun 6, 2011
  4. 2/5 gitweb: Describe CSSMIN and JSMIN in gitweb/INSTALLJakub Narebski, Jun 6, 2011
  5. Jonathan NiederJun 6, 2011
  6. Jakub NarebskiJun 8, 2011
  7. 3/5 gitweb: Move "Requirements" up in gitweb/INSTALLJakub Narebski, Jun 6, 2011
  8. Jonathan NiederJun 6, 2011
  9. 4/5 gitweb: Starting work on a man page for /etc/gitweb.conf (WIP)Jakub Narebski, Jun 6, 2011
  10. Jonathan NiederJun 6, 2011
  11. Jonathan NiederJun 6, 2011
  12. Jakub NarebskiJun 8, 2011
  13. Drew NorthupJun 7, 2011
  14. Jonathan NiederJun 7, 2011
  15. Drew NorthupJun 7, 2011
  16. Jakub NarebskiJun 7, 2011
  17. Junio C HamanoJun 7, 2011
  18. Drew NorthupJun 7, 2011
  19. Jakub NarebskiJun 7, 2011
  20. Drew NorthupJun 7, 2011
  21. Jakub NarebskiJun 10, 2011
  22. Jakub NarebskiJun 8, 2011
  23. 5/5 gitweb: Starting work on a man page for gitweb (WIP)Jakub Narebski, Jun 6, 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.