From: Neil Jerram <neil@ossau.uklinux.net>
To: Andy Wingo <wingo@pobox.com>
Cc: bug-guile@gnu.org
Subject: Re: More missing options for guile/doc/guile.1
Date: Wed, 26 Jan 2011 21:49:02 +0000 [thread overview]
Message-ID: <87wrlrqqsx.fsf@ossau.uklinux.net> (raw)
In-Reply-To: <m3pqrjeagh.fsf@unquote.localdomain> (Andy Wingo's message of "Wed, 26 Jan 2011 20:22:54 +0100")
Andy Wingo <wingo@pobox.com> writes:
> On Sat 15 Jan 2011 22:15, Neil Jerram <neil@ossau.uklinux.net> writes:
>
>> Mark Harig <idirectscm@aim.com> writes:
>>
>>> Here is a list of additional options that are not described
>>> in the guile manual page:
>>
>> Thank you for pointing these out, and for suggesting suitable text.
>> However, rather than applying these updates, I wonder if the OPTIONS
>> section of guile.1 should instead be autogenerated from the `Invoking
>> Guile' node of the manual?
>>
>> Andy/Ludo, any objection to that?
>
> I have no objection, no; and I'm sorry I didn't see this mail before
> committing some other changes and asking for feedback. I'm a bit
> behind, you see!
No prob.
> How do you see the man page? Should it be complete, or terse? I am
> leaning towards the latter, to be honest...
One reasonable answer would be:
- complete as regards invocation options - because in practice, that's
mostly what I use man pages for, and I imagine that's true for many
people
- otherwise in line with other GNU applications (such as in the ways
that Mark pointed out)
- obviously, pointing to the manual for the full documentation.
But I'm not wedded to the first point here. I guess we could just say
guile [OPTIONS] [SCRIPT]
and then point to the manual for more details. More generally, I'd say
the minimum requirements are just for the man page to have some kind of
structural sense, not to say anything actively wrong, to point to the
manual, and to conform to any GNU project reqts, such as about copying.
Neil
next prev parent reply other threads:[~2011-01-26 21:49 UTC|newest]
Thread overview: 9+ messages / expand[flat|nested] mbox.gz Atom feed top
2011-01-13 23:13 More missing options for guile/doc/guile.1 Mark Harig
2011-01-15 21:15 ` Neil Jerram
2011-01-17 22:25 ` Ludovic Courtès
2011-01-26 19:22 ` Andy Wingo
2011-01-26 21:49 ` Neil Jerram [this message]
2011-01-27 17:06 ` Ludovic Courtès
2011-01-27 19:25 ` Mark Harig
2011-01-27 22:35 ` Andy Wingo
[not found] ` <8CD8C7DAC060621-190C-94B30@Webmail-d109.sysops.aol.com>
2011-01-27 22:52 ` Andy Wingo
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
List information: https://www.gnu.org/software/guile/
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=87wrlrqqsx.fsf@ossau.uklinux.net \
--to=neil@ossau.uklinux.net \
--cc=bug-guile@gnu.org \
--cc=wingo@pobox.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 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 read-only IMAP folder(s) and NNTP newsgroup(s).