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

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

 



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

--
To unsubscribe from this list: send the line "unsubscribe git" in
the body of a message to majordomo@xxxxxxxxxxxxxxx
More majordomo info at  http://vger.kernel.org/majordomo-info.html


[Index of Archives]     [Linux Kernel Development]     [Gcc Help]     [IETF Annouce]     [DCCP]     [Netdev]     [Networking]     [Security]     [V4L]     [Bugtraq]     [Yosemite]     [MIPS Linux]     [ARM Linux]     [Linux Security]     [Linux RAID]     [Linux SCSI]     [Fedora Users]