From: Jakub Narebski <jnareb@gmail.com>
To: git@vger.kernel.org, Drew Northup <drew.northup@maine.edu>
Cc: Jonathan Nieder <jrnieder@gmail.com>,
John 'Warthog9' Hawley <warthog9@kernel.org>,
admin@repo.or.cz, Jakub Narebski <jnareb@gmail.com>
Subject: [PATCH/RFCv4 0/4] Moving gitweb documentation to manpages
Date: Sun, 18 Sep 2011 15:34:40 +0200 [thread overview]
Message-ID: <1316352884-26193-1-git-send-email-jnareb@gmail.com> (raw)
The original patch adding manpage for /etc/gitweb.conf was sent by
Drew Northup; I have added manpage for gitweb itself, inspired by his
patch. Unfortunately Drew doesn't currently have time to work on this
patch (patch series), so that is why it is me resending this series.
It is closer to final version, but still is a bit work in progres.
The main improvement is that documentation now renders correctly as
HTML.
Note that we should probably add gitweb(1) and gitweb.conf(5) manpages
to the list in git(1) manpage.
Table of contents:
~~~~~~~~~~~~~~~~~~
1. The changes to Documentation/Makefile adding gitweb-doc target and
to gitweb/Makefile adding doc target are now upfront as a separate
patch, compared to previous version of this series:
"[RFC/PATCHv3 0/5] Improving gitweb documentation, creating manpages"
http://thread.gmane.org/gmane.comp.version-control.git/175140
This is mainly so that description of ideas, which is common for both
gitweb.conf.txt and gitweb.txt, is in a separate upfront commit
message.
2. The man page for /etc/gitweb.conf is modified, extended and
improved version of original 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
is also checked that it renders correctly as HTML and as manpage,
compared to version send earlier in
"[RFC/PATCHv3 4/5] gitweb: Starting work on a man page for /etc/gitweb.conf (WIP)"
http://thread.gmane.org/gmane.comp.version-control.git/175140/focus=175145
This version now moves, rather than copies, contents from
gitweb/README file. It now has up-to-date commit message.
It was also updated to include new gitweb-comon.conf config file
(common system-wide config file, used *in addition to* per-instance
gitweb_config.perl config file).
3. The man page for gitweb is improved version of patch I have sent to
git mailing list as
"[RFC/PATCHv3 5/5] gitweb: Starting work on a man page for gitweb (WIP)"
http://thread.gmane.org/gmane.comp.version-control.git/175140/focus=175146
This version was fixed to render correctly as HTML and as manpage, and
has update commit message.
4. The addition of gitweb manpages to 'gitweb' subpackage in
gitweb.spec (via gitweb.spec.in) is new in this series.
Shortlog:
~~~~~~~~~
Drew Northup (1):
gitweb: Add manpage for /etc/gitweb.conf (for gitweb documentation)
Jakub Narebski (3):
Documentation: Preparation for gitweb manpages
gitweb: Add manpage for gitweb
gitweb: Add gitweb manpages to 'gitweb' package in git.spec
Diffstat:
~~~~~~~~~
Documentation/Makefile | 7 +-
Documentation/gitweb.conf.txt | 789 +++++++++++++++++++++++++++++++++++++++++
Documentation/gitweb.txt | 703 ++++++++++++++++++++++++++++++++++++
git.spec.in | 7 +
gitweb/INSTALL | 96 +-----
gitweb/Makefile | 7 +-
gitweb/README | 411 ++--------------------
7 files changed, 1540 insertions(+), 480 deletions(-)
create mode 100644 Documentation/gitweb.conf.txt
create mode 100644 Documentation/gitweb.txt
--
1.7.6
next reply other threads:[~2011-09-18 13:35 UTC|newest]
Thread overview: 12+ messages / expand[flat|nested] mbox.gz Atom feed top
2011-09-18 13:34 Jakub Narebski [this message]
2011-09-18 13:34 ` [PATCH/RFCv4 1/4] Documentation: Preparation for gitweb manpages Jakub Narebski
2011-09-19 23:37 ` Jonathan Nieder
2011-09-20 0:10 ` Jakub Narebski
2011-09-20 20:11 ` Jakub Narebski
2011-09-20 20:19 ` Jonathan Nieder
2011-09-20 20:33 ` Jakub Narebski
2011-09-18 13:34 ` [PATCH/RFCv4 2/4] gitweb: Add manpage for /etc/gitweb.conf (for gitweb documentation) Jakub Narebski
2011-09-20 4:41 ` Jonathan Nieder
2011-09-22 13:41 ` Jakub Narebski
2011-09-18 13:34 ` [PATCH/RFCv4 3/4] gitweb: Add manpage for gitweb Jakub Narebski
2011-09-18 13:34 ` [PATCH/RFCv4 4/4] gitweb: Add gitweb manpages to 'gitweb' package in git.spec Jakub Narebski
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=1316352884-26193-1-git-send-email-jnareb@gmail.com \
--to=jnareb@gmail.com \
--cc=admin@repo.or.cz \
--cc=drew.northup@maine.edu \
--cc=git@vger.kernel.org \
--cc=jrnieder@gmail.com \
--cc=warthog9@kernel.org \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).