From: Jakub Narebski <jnareb@gmail.com>
To: git@vger.kernel.org
Cc: John 'Warthog9' Hawley <warthog9@kernel.org>,
Petr Baudis <pasky@suse.cz>,
Drew Northup <drew.northup@maine.edu>,
Jonathan Nieder <jrnieder@gmail.com>,
Jakub Narebski <jnareb@gmail.com>
Subject: [RFC/PATCHv3 0/5] Improving gitweb documentation, creating manpages
Date: Mon, 6 Jun 2011 19:44:26 +0200 [thread overview]
Message-ID: <1307382271-7677-1-git-send-email-jnareb@gmail.com> (raw)
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 reply other threads:[~2011-06-06 17:51 UTC|newest]
Thread overview: 23+ messages / expand[flat|nested] mbox.gz Atom feed top
2011-06-06 17:44 Jakub Narebski [this message]
2011-06-06 17:44 ` [PATCHv3 1/5] gitweb: Move information about installation from README to INSTALL Jakub Narebski
2011-06-06 19:44 ` Jonathan Nieder
2011-06-06 17:44 ` [PATCHv3 2/5] gitweb: Describe CSSMIN and JSMIN in gitweb/INSTALL Jakub Narebski
2011-06-06 20:01 ` Jonathan Nieder
2011-06-08 11:32 ` Jakub Narebski
2011-06-06 17:44 ` [PATCHv3 3/5] gitweb: Move "Requirements" up " Jakub Narebski
2011-06-06 20:05 ` Jonathan Nieder
2011-06-06 17:44 ` [RFC/PATCHv3 4/5] gitweb: Starting work on a man page for /etc/gitweb.conf (WIP) Jakub Narebski
2011-06-06 22:12 ` Jonathan Nieder
2011-06-06 22:25 ` Jonathan Nieder
2011-06-08 16:40 ` Jakub Narebski
2011-06-07 13:00 ` Drew Northup
2011-06-07 13:44 ` Jonathan Nieder
2011-06-07 16:27 ` Drew Northup
2011-06-07 16:41 ` Jakub Narebski
2011-06-07 17:00 ` Junio C Hamano
2011-06-07 17:43 ` Drew Northup
2011-06-07 19:36 ` Jakub Narebski
2011-06-07 19:50 ` Drew Northup
2011-06-10 17:16 ` Jakub Narebski
2011-06-08 16:35 ` Jakub Narebski
2011-06-06 17:44 ` [RFC/PATCHv3 5/5] gitweb: Starting work on a man page for gitweb (WIP) 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=1307382271-7677-1-git-send-email-jnareb@gmail.com \
--to=jnareb@gmail.com \
--cc=drew.northup@maine.edu \
--cc=git@vger.kernel.org \
--cc=jrnieder@gmail.com \
--cc=pasky@suse.cz \
--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).