checkpatch.rst: Remove info that is already in the manual page

Signed-off-by: Alejandro Colomar <alx.manpages@gmail.com>

1 files changed, 2 insertions, 216 deletions

diff --git a/share/doc/checkpatch/checkpatch.rst b/share/doc/checkpatch/checkpatch.rst
index b52452b..b23c939 100644
--- a/share/doc/checkpatch/checkpatch.rst
+++ b/share/doc/checkpatch/checkpatch.rst
@@ -12,223 +12,9 @@ Checkpatch is not always right. Your judgement takes precedence over checkpatch
 messages.  If your code looks better with the violations, then its probably
 best left alone.
 
+This document describes the message types.  For a description of usage of the
+command, including the options, read the manual page.
 
-Options
-=======
-
-This section will describe the options checkpatch can be run with.
-
-Usage::
-
-  ./scripts/checkpatch.pl [OPTION]... [FILE]...
-
-Available options:
-
- - -q,  --quiet
-
-   Enable quiet mode.
-
- - -v,  --verbose
-   Enable verbose mode.  Additional verbose test descriptions are output
-   so as to provide information on why that particular message is shown.
-
- - --no-tree
-
-   Run checkpatch without the kernel tree.
-
- - --no-signoff
-
-   Disable the 'Signed-off-by' line check.  The sign-off is a simple line at
-   the end of the explanation for the patch, which certifies that you wrote it
-   or otherwise have the right to pass it on as an open-source patch.
-
-   Example::
-
-	 Signed-off-by: Random J Developer <random@developer.example.org>
-
-   Setting this flag effectively stops a message for a missing signed-off-by
-   line in a patch context.
-
- - --patch
-
-   Treat FILE as a patch.  This is the default option and need not be
-   explicitly specified.
-
- - --emacs
-
-   Set output to emacs compile window format.  This allows emacs users to jump
-   from the error in the compile window directly to the offending line in the
-   patch.
-
- - --terse
-
-   Output only one line per report.
-
- - --showfile
-
-   Show the diffed file position instead of the input file position.
-
- - -g,  --git
-
-   Treat FILE as a single commit or a git revision range.
-
-   Single commit with:
-
-   - <rev>
-   - <rev>^
-   - <rev>~n
-
-   Multiple commits with:
-
-   - <rev1>..<rev2>
-   - <rev1>...<rev2>
-   - <rev>-<count>
-
- - -f,  --file
-
-   Treat FILE as a regular source file.  This option must be used when running
-   checkpatch on source files in the kernel.
-
- - --subjective,  --strict
-
-   Enable stricter tests in checkpatch.  By default the tests emitted as CHECK
-   do not activate by default.  Use this flag to activate the CHECK tests.
-
- - --list-types
-
-   Every message emitted by checkpatch has an associated TYPE.  Add this flag
-   to display all the types in checkpatch.
-
-   Note that when this flag is active, checkpatch does not read the input FILE,
-   and no message is emitted.  Only a list of types in checkpatch is output.
-
- - --types TYPE(,TYPE2...)
-
-   Only display messages with the given types.
-
-   Example::
-
-     ./scripts/checkpatch.pl mypatch.patch --types EMAIL_SUBJECT,BRACES
-
- - --ignore TYPE(,TYPE2...)
-
-   Checkpatch will not emit messages for the specified types.
-
-   Example::
-
-     ./scripts/checkpatch.pl mypatch.patch --ignore EMAIL_SUBJECT,BRACES
-
- - --show-types
-
-   By default checkpatch doesn't display the type associated with the messages.
-   Set this flag to show the message type in the output.
-
- - --max-line-length=n
-
-   Set the max line length (default 100).  If a line exceeds the specified
-   length, a LONG_LINE message is emitted.
-
-
-   The message level is different for patch and file contexts.  For patches,
-   a WARNING is emitted.  While a milder CHECK is emitted for files.  So for
-   file contexts, the --strict flag must also be enabled.
-
- - --min-conf-desc-length=n
-
-   Set the Kconfig entry minimum description length, if shorter, warn.
-
- - --tab-size=n
-
-   Set the number of spaces for tab (default 8).
-
- - --root=PATH
-
-   PATH to the kernel tree root.
-
-   This option must be specified when invoking checkpatch from outside
-   the kernel root.
-
- - --no-summary
-
-   Suppress the per file summary.
-
- - --mailback
-
-   Only produce a report in case of Warnings or Errors.  Milder Checks are
-   excluded from this.
-
- - --summary-file
-
-   Include the filename in summary.
-
- - --debug KEY=[0|1]
-
-   Turn on/off debugging of KEY, where KEY is one of 'values', 'possible',
-   'type', and 'attr' (default is all off).
-
- - --fix
-
-   This is an EXPERIMENTAL feature.  If correctable errors exists, a file
-   <inputfile>.EXPERIMENTAL-checkpatch-fixes is created which has the
-   automatically fixable errors corrected.
-
- - --fix-inplace
-
-   EXPERIMENTAL - Similar to --fix but input file is overwritten with fixes.
-
-   DO NOT USE this flag unless you are absolutely sure and you have a backup
-   in place.
-
- - --ignore-perl-version
-
-   Override checking of perl version.  Runtime errors maybe encountered after
-   enabling this flag if the perl version does not meet the minimum specified.
-
- - --codespell
-
-   Use the codespell dictionary for checking spelling errors.
-
- - --codespellfile
-
-   Use the specified codespell file.
-   Default is '/usr/share/codespell/dictionary.txt'.
-
- - --typedefsfile
-
-   Read additional types from this file.
-
- - --color[=WHEN]
-
-   Use colors 'always', 'never', or only when output is a terminal ('auto').
-   Default is 'auto'.
-
- - --kconfig-prefix=WORD
-
-   Use WORD as a prefix for Kconfig symbols (default is `CONFIG_`).
-
- - -h, --help, --version
-
-   Display the help text.
-
-Message Levels
-==============
-
-Messages in checkpatch are divided into three levels. The levels of messages
-in checkpatch denote the severity of the error. They are:
-
- - ERROR
-
-   This is the most strict level.  Messages of type ERROR must be taken
-   seriously as they denote things that are very likely to be wrong.
-
- - WARNING
-
-   This is the next stricter level.  Messages of type WARNING requires a
-   more careful review.  But it is milder than an ERROR.
-
- - CHECK
-
-   This is the mildest level.  These are things which may require some thought.
 
 Type Descriptions
 =================