From: Theodore Tso <tytso@mit.edu>
To: Yang Hongyang <imhy.yang@gmail.com>
Cc: Yang Hongyang <yanghy@cn.fujitsu.com>,
netdev@vger.kernel.org, "David S. Miller" <davem@davemloft.net>,
linux-kernel@vger.kernel.org,
Andrew Morton <akpm@linux-foundation.org>,
linux-doc@vger.kernel.org, mtk.manpages@gmail.com,
rdunlap@xenotime.net
Subject: Re: Documentation:Update the INDEX of the documents
Date: Wed, 25 Feb 2009 10:56:28 -0500 [thread overview]
Message-ID: <20090225155628.GM7064@mit.edu> (raw)
In-Reply-To: <a669f14b0902250725j4c21463eqc1b88092486f38ad@mail.gmail.com>
On Wed, Feb 25, 2009 at 11:25:08PM +0800, Yang Hongyang wrote:
> > If folks do find the 00-INDEX files useful, my suggestion would be to
> > make a way of automatically extracting them from the individual files
> > and/or directories, and then making the 00-INDEX files to be
> > automatically generated.
>
> Sounds like a good idea but How to automatically generate
> the summaries then?
Well, for text files (including subdirectory's 00-INDEX files) we
could have a convention which is the first line of the file should be
a (max 60 characters) one-line summary of the file.
We would probably have to do something special with non-free-form-text
files, including structured text files like Docbook files. So it's
not quite so straightforward, but it should be doable.
- Ted
next prev parent reply other threads:[~2009-02-25 15:57 UTC|newest]
Thread overview: 17+ messages / expand[flat|nested] mbox.gz Atom feed top
2009-02-25 7:16 Documentation:Update the INDEX of the documents Yang Hongyang
2009-02-25 7:16 ` Yang Hongyang
2009-02-25 9:42 ` Rob Landley
2009-02-25 9:42 ` Rob Landley
2009-02-25 14:59 ` Theodore Tso
2009-02-25 15:05 ` Yang Hongyang
2009-02-25 15:05 ` Yang Hongyang
2009-02-25 15:25 ` Yang Hongyang
2009-02-25 15:25 ` Yang Hongyang
2009-02-25 15:56 ` Theodore Tso [this message]
2009-02-26 0:49 ` Yang Hongyang
2009-02-26 0:49 ` Yang Hongyang
2009-02-26 0:52 ` Randy Dunlap
2009-02-26 0:59 ` Yang Hongyang
2009-02-26 2:37 ` Theodore Tso
2009-02-26 6:04 ` Rob Landley
2009-02-25 19:30 ` Rob Landley
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=20090225155628.GM7064@mit.edu \
--to=tytso@mit.edu \
--cc=akpm@linux-foundation.org \
--cc=davem@davemloft.net \
--cc=imhy.yang@gmail.com \
--cc=linux-doc@vger.kernel.org \
--cc=linux-kernel@vger.kernel.org \
--cc=mtk.manpages@gmail.com \
--cc=netdev@vger.kernel.org \
--cc=rdunlap@xenotime.net \
--cc=yanghy@cn.fujitsu.com \
/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 an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.