From: J William Piggott <elseifthen@gmx.com>
To: Karel Zak <kzak@redhat.com>
Cc: util-linux@vger.kernel.org
Subject: [PATCH 4/4] Docs: move option naming to howto-contribute.txt
Date: Sun, 25 Jun 2017 17:51:49 -0400 [thread overview]
Message-ID: <5dbba0e9-b262-00db-3863-e4d71f68b2e6@gmx.com> (raw)
In-Reply-To: <e5059958-a9b9-2ff4-f1b8-6122520bacac@gmx.com>
Creating and naming options is not done when writing usage().
A contributor may not even read howto-usage-function.txt, but
they should read howto-contribute.txt. So move option naming
and change information there.
Signed-off-by: J William Piggott <elseifthen@gmx.com>
---
Documentation/howto-contribute.txt | 25 +++++++++++++++++++++++++
Documentation/howto-usage-function.txt | 28 ----------------------------
2 files changed, 25 insertions(+), 28 deletions(-)
diff --git a/Documentation/howto-contribute.txt b/Documentation/howto-contribute.txt
index 245f9ab..e63d390 100644
--- a/Documentation/howto-contribute.txt
+++ b/Documentation/howto-contribute.txt
@@ -3,6 +3,7 @@ CONTENTS
Patching Process
Email Format
Coding Style
+ Options
Various Notes
Standards Compliance
@@ -155,6 +156,30 @@ Coding Style
multiple lines. In case the shorthand does not look good on one line
use the normal "if () else" syntax.
+Options
+
+ * The rule of thumb for options is that once they exist, you may not
+ change them, nor change how they work, nor remove them.
+
+ * The following options are well-known, and should not be used for any
+ other purpose:
+
+ -h, --help display usage and exit
+ -V, --version display version and exit
+
+ * Some commands use peculiar options and arguments. These will continue
+ to be supported, but anything like them will not be accepted as new
+ additions. A short list of examples:
+
+ Characters other than '-' to start an option. See '+' in 'more'.
+
+ Using a number as an option. See '-<number>' in 'more'.
+
+ Long options that start with a single '-'. See 'setterm'.
+
+ '-?' is not a synonym for '--help', but is an unknown option
+ resulting in a suggestion to try --help due to a getopt failure.
+
Various Notes
* util-linux does not use kernel headers for file system super
diff --git a/Documentation/howto-usage-function.txt b/Documentation/howto-usage-function.txt
index 1c5c4b8..a666d44 100644
--- a/Documentation/howto-usage-function.txt
+++ b/Documentation/howto-usage-function.txt
@@ -4,20 +4,6 @@ Example file
Refer to the ./boilerplate.c example file while reading this howto.
-Well-known options
-------------------
-
-The following options are well-known, and should not be used for any
-other purpose:
-
- -h, --help display usage and exit
- -V, --version display version and exit
-
-The rule of thumb with other options is that once they exist, you may
-not change them, nor change how they work, nor remove them.
-
-See Legacy options below.
-
How a usage text is supposed to look
------------------------------------
@@ -146,17 +132,3 @@ define. The command author, package maintainer or patch submitter will
usually know when it should be done that way.
-Legacy options
---------------
-
-Some commands use peculiar options and arguments. These will continue
-to be supported, but anything like them will not be accepted as new
-additions. A short list of examples:
-
-- Characters other than '-' to start an option. See '+' in 'more'.
-- Using a number as an option. See '-<number>' in 'more'.
-- Long options that start with a single '-'. See 'setterm'.
-- '-?' is not expected to be a synonym of '--help', but is an unknown
- option resulting in a suggestion to try --help due to a getopt failure.
-
-
next prev parent reply other threads:[~2017-06-25 21:51 UTC|newest]
Thread overview: 9+ messages / expand[flat|nested] mbox.gz Atom feed top
2017-06-25 21:45 [PATCH 0/4] pull request J William Piggott
2017-06-25 21:47 ` [PATCH 1/4] include/c.h: add USAGE_COMMANDS and USAGE_COLUMNS J William Piggott
2017-06-25 21:49 ` [PATCH 2/4] Docs: add a comment for constants to boilerplate.c J William Piggott
2017-06-25 21:50 ` [PATCH 3/4] Docs: update howto-usage-function.txt J William Piggott
2017-06-25 21:51 ` J William Piggott [this message]
2017-06-26 8:27 ` [PATCH 0/4] pull request Karel Zak
2017-06-26 12:11 ` Karel Zak
2017-06-26 13:47 ` J William Piggott
2017-06-26 14:25 ` Karel Zak
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=5dbba0e9-b262-00db-3863-e4d71f68b2e6@gmx.com \
--to=elseifthen@gmx.com \
--cc=kzak@redhat.com \
--cc=util-linux@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).