From: Goffredo Baroncelli <kreijack@libero.it>
To: linux-btrfs <linux-btrfs@vger.kernel.org>
Subject: [PATCH 0/6] Move the infor for the help/man page in the source
Date: Tue, 19 Jul 2011 18:11:53 +0200 [thread overview]
Message-ID: <20110719161049.3210.54794.stgit@venice.bhome> (raw)
The following series implement a way to generate the help messages and
the btrfs man page from the sources comments for the "btrfs" commanda
.
The syntax and the detailed help of every subcommand are stored in
the comments before the function which implements the subcommand.
The fact that the help messages and the man page are generated from the
same source should help to avoid incoherencies and mistakes.
Moreover tha fact that the source and the help are strictly linked
helps to avoid man page/help outdated.
You can pull the changes from
You can download the source from
http://cassiopea.homelinux.net/git/btrfs-progs-unstable.git
branch extended-help
and/or browse the code at
http://cassiopea.homelinux.net/git/?p=btrfs-progs-unstable.git
BR
G.Baroncelli
---
Goffredo Baroncelli (6):
Add info for the commands.
Add the header/footer/introduction of the man page.
helpextract: tool to extract the info for the help from the source.
Update the makefile for generating the man page.
Show the help messages from the info in the comment.
Update the makefile for generating the help messages.
Makefile | 28 +++
btrfs.c | 210 +++++++++++++++++++++++++
btrfs_cmds.c | 276 +++++++++++++++++++++++++++++++++
helpextract.c | 435 ++++++++++++++++++++++++++++++++++++++++++++++++++++
man/btrfs.8.in | 359 -------------------------------------------
man/btrfs.8.in.old | 359 +++++++++++++++++++++++++++++++++++++++++++
scrub.c | 79 +++++++++
7 files changed, 1380 insertions(+), 366 deletions(-)
create mode 100644 helpextract.c
delete mode 100644 man/btrfs.8.in
create mode 100644 man/btrfs.8.in.old
next reply other threads:[~2011-07-19 16:11 UTC|newest]
Thread overview: 7+ messages / expand[flat|nested] mbox.gz Atom feed top
2011-07-19 16:11 Goffredo Baroncelli [this message]
2011-07-19 16:11 ` [PATCH 1/6] Add info for the commands Goffredo Baroncelli
2011-07-19 16:12 ` [PATCH 2/6] Add the header/footer/introduction of the man page Goffredo Baroncelli
2011-07-19 16:12 ` [PATCH 3/6] helpextract: tool to extract the info for the help from the source Goffredo Baroncelli
2011-07-19 16:12 ` [PATCH 4/6] Update the makefile for generating the man page Goffredo Baroncelli
2011-07-19 16:12 ` [PATCH 5/6] Show the help messages from the info in the comment Goffredo Baroncelli
2011-07-19 16:12 ` [PATCH 6/6] Update the makefile for generating the help messages Goffredo Baroncelli
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=20110719161049.3210.54794.stgit@venice.bhome \
--to=kreijack@libero.it \
--cc=linux-btrfs@vger.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).