[DRE-commits] [rake] 09/11: updated and revised manpage
Caitlin Matos
cm-guest at moszumanska.debian.org
Thu Aug 28 16:12:56 UTC 2014
This is an automated email from the git hooks/post-receive script.
cm-guest pushed a commit to branch master
in repository rake.
commit 4bf388b517fe393d619e401cae0316c3e2cc75d9
Author: Caitlin Matos <caitlin.matos at zoho.com>
Date: Thu Aug 28 12:00:20 2014 -0400
updated and revised manpage
See better-manpage.patch for more information.
---
debian/patches/better-manpage.patch | 162 ++++++++++++++++++++++++++++++++++++
debian/patches/series | 1 +
debian/rake.1 | 73 ----------------
debian/rake.manpages | 2 +-
4 files changed, 164 insertions(+), 74 deletions(-)
diff --git a/debian/patches/better-manpage.patch b/debian/patches/better-manpage.patch
new file mode 100644
index 0000000..79cf62f
--- /dev/null
+++ b/debian/patches/better-manpage.patch
@@ -0,0 +1,162 @@
+Description: replace doc/rake.1.gz with an updated and improved manpage
+ The upstream manpage has not been updated for over 9 years and does not follow
+ many manpage conventions. The manpage included in the Debian packaging is also
+ outdated. I have generated a new manpage with much reorganizing and
+ reformatting. I have submitted this manpage upstream for inclusion in a later
+ release of rake (hopefully). This patch should be removed once an updated
+ manpage is included upstream.
+Author: Caitlin Matos <caitlin.matos at zoho.com>
+Bug: https://github.com/jimweirich/rake/pull/291
+Last-Update: 2014-08-28
+---
+This patch header follows DEP-3: http://dep.debian.net/deps/dep3/
+--- /dev/null
++++ b/doc/rake.1
+@@ -0,0 +1,147 @@
++.\" Hey, EMACS: -*- nroff -*-
++.\" First parameter, NAME, should be all caps
++.\" Second parameter, SECTION, should be 1-8, maybe w/ subsection
++.\" other parameters are allowed: see man(7), man(1)
++.TH RAKE 1 "August 28, 2014" "rake 10.3.2" "Rake User Commands"
++.\" Please adjust this date whenever revising the manpage.
++.\"
++.\" Some roff macros, for reference:
++.\" .nh disable hyphenation
++.\" .hy enable hyphenation
++.\" .ad l left justify
++.\" .ad b justify to both left and right margins
++.\" .nf disable filling
++.\" .fi enable filling
++.\" .br insert line break
++.\" .sp <n> insert n+1 empty lines
++.\" for manpage-specific macros, see man(7)
++.SH NAME
++rake \- a make-like build utility for Ruby
++.SH SYNOPSIS
++\fBrake\fR [\fI\-f rakefile\fR] {\fIOPTIONS\fR} \fITARGETS...\fR
++.br
++.SH DESCRIPTION
++.B rake
++is a make-like build utility for Ruby. Tasks and dependencies are specified in
++standard Ruby syntax.
++.SH OPTIONS
++.TP
++\fB\-m\fR, \fB\-\-multitask\fR
++Treat all tasks as multitasks.
++.TP
++\fB\-B\fR, \fB\-\-build\-all\fR
++Build all prerequisites, including those which are up\-to\-date.
++
++.TP
++\fB\-j\fR, \fB\-\-jobs\fR [\fINUMBER\fR]
++Specifies the maximum number of tasks to execute in parallel (default is number of CPU cores + 4).
++
++.SS Modules
++.TP
++\fB\-I\fR, \fB\-\-libdir\fR \fILIBDIR\fR
++Include \fILIBDIR\fR in the search path for required modules.
++.TP
++\fB\-r\fR, \fB\-\-require\fR \fIMODULE\fR
++Require \fIMODULE\fR before executing rakefile.
++
++.SS Rakefile location
++.TP
++\fB\-f\fR, \fB\-\-rakefile\fR [\fIFILENAME\fR]
++Use \fIFILENAME\fR as the rakefile to search for.
++.TP
++\fB\-N\fR, \fB\-\-no\-search\fR, \fB\-\-nosearch\fR
++Do not search parent directories for the Rakefile.
++.TP
++\fB\-G\fR, \fB\-\-no\-system\fR, \fB\-\-nosystem\fR
++Use standard project Rakefile search paths, ignore system wide rakefiles.
++.TP
++\fB\-R\fR, \fB\-\-rakelibdir\fR \fIRAKELIBDIR\fR
++Auto\-import any .rake files in \fIRAKELIBDIR\fR (default is 'rakelib')
++.HP
++\fB\-\-rakelib\fR
++.TP
++\fB\-g\fR, \fB\-\-system\fR
++Using system wide (global) rakefiles (usually '\fI~/.rake/*.rake\fR').
++
++.SS Debugging
++.TP
++\fB\-\-backtrace\fR=\fI\,[OUT]\/\fR
++Enable full backtrace. \fIOUT\fR can be stderr (default) or stdout.
++.TP
++\fB\-t\fR, \fB\-\-trace\fR=\fI\,[OUT]\/\fR
++Turn on invoke/execute tracing, enable full backtrace. \fIOUT\fR can be stderr (default) or stdout.
++.TP
++\fB\-\-suppress\-backtrace\fR \fIPATTERN\fR
++Suppress backtrace lines matching regexp \fIPATTERN\fR. Ignored if \fI\-\-trace\fR is on.
++.TP
++\fB\-\-rules\fR
++Trace the rules resolution.
++
++.TP
++\fB\-n\fR, \fB\-\-dry\-run\fR
++Do a dry run without executing actions.
++.TP
++\fB\-T\fR, \fB\-\-tasks\fR [\fIPATTERN\fR]
++Display the tasks (matching optional \fIPATTERN\fR) with descriptions, then exit.
++.TP
++\fB\-D\fR, \fB\-\-describe\fR [\fIPATTERN\fR]
++Describe the tasks (matching optional \fIPATTERN\fR), then exit.
++.TP
++\fB\-W\fR, \fB\-\-where\fR [\fIPATTERN\fR]
++Describe the tasks (matching optional \fIPATTERN\fR), then exit.
++.TP
++\fB\-P\fR, \fB\-\-prereqs\fR
++Display the tasks and dependencies, then exit.
++
++.TP
++\fB\-e\fR, \fB\-\-execute\fR \fICODE\fR
++Execute some Ruby code and exit.
++.TP
++\fB\-p\fR, \fB\-\-execute\-print\fR \fICODE\fR
++Execute some Ruby code, print the result, then exit.
++.TP
++\fB\-E\fR, \fB\-\-execute\-continue\fR \fICODE\fR
++Execute some Ruby code, then continue with normal task processing.
++
++.SS Information
++.TP
++\fB\-v\fR, \fB\-\-verbose\fR
++Log message to standard output.
++.TP
++\fB\-q\fR, \fB\-\-quiet\fR
++Do not log messages to standard output.
++.TP
++\fB\-s\fR, \fB\-\-silent\fR
++Like \fB\-\-quiet\fR, but also suppresses the 'in directory' announcement.
++.TP
++\fB\-X\fR, \fB\-\-no\-deprecation\-warnings\fR
++Disable the deprecation warnings.
++.TP
++\fB\-\-comments\fR
++Show commented tasks only
++.TP
++\fB\-A\fR, \fB\-\-all\fR
++Show all tasks, even uncommented ones (in combination with \fB\-T\fR or \fB\-D\fR)
++.TP
++\fB\-\-job\-stats\fR [\fILEVEL\fR]
++Display job statistics. \fILEVEL=history\fR displays a complete job list
++.TP
++\fB\-V\fR, \fB\-\-version\fR
++Display the program version.
++.TP
++\fB\-h\fR, \fB\-H\fR, \fB\-\-help\fR
++Display a help message.
++
++.nh
++.SH SEE ALSO
++The complete documentation for \fBrake\fR is contained in a separate package,
++\fBrake-doc\fR. If the documentation has been installed locally, it can be
++found at \fI/usr/share/doc/rake-doc/html/index.html\fR.
++
++The complete documentation is also available online at
++\fIhttp://docs.seattlerb.org/rake\fR.
++.SH AUTHOR
++.B rake
++was written by Jim Weirich <jim at weirichhouse.org>.
++.PP
++This manual was created by Caitlin Matos <caitlin.matos at zoho.com> for the Debian project (but may be used by others). It was inspired by the manual by Jani Monoses <jani at iv.ro> for the Ubuntu project.
diff --git a/debian/patches/series b/debian/patches/series
index 4d4a1b2..99083eb 100644
--- a/debian/patches/series
+++ b/debian/patches/series
@@ -1,3 +1,4 @@
0001-remove_rubygems.patch
skip_permission_test.patch
autopkgtest.patch
+better-manpage.patch
diff --git a/debian/rake.1 b/debian/rake.1
deleted file mode 100644
index ff5b15c..0000000
--- a/debian/rake.1
+++ /dev/null
@@ -1,73 +0,0 @@
-.\" In .TH, FOO should be all caps, SECTION should be 1-8, maybe w/ subsection
-.\" other parms are allowed: see man(7), man(1)
-.\"
-.\" This template provided by Tom Christiansen <tchrist at jhereg.perl.com>.
-.\"
-.TH RAKE 1
-.SH NAME
-rake \- a ruby build program with capabilities similar to make
-.SH SYNOPSIS
-A short usage summary.
-.PP
-.B rake
-.I options
-.\".SH DESCRIPTION
-.\" Putting a newline after each sentence can generate better output.
-.\"Rake is a simple ruby build program with capabilities similar to make.
-
-.SH OPTIONS
-.TP
-.BR \-n,\-\-dry\-run
- Do a dry run without executing actions.
-.TP
-.BR \-H,\-\-help
- Display this help message.
-.TP
-.BR \-I,\-\-libdir=LIBDIR
- Include LIBDIR in the search path for required modules.
-.TP
-.BR \-N\-\-nosearch
- Do not search parent directories for the Rakefile.
-.TP
-.BR \-P,\-\-prereqs
- Display the tasks and dependencies, then exit.
-.TP
-.BR \-q,\-\-quiet
- Do not log messages to standard output
-.TP
-.BR \-f,\-\-rakefile=FILE
- Use FILE as the rakefile.
-.TP
-.BR \-r,\-\-require=MODULE
- Require MODULE before executing rakefile.
-.TP
-.BR \-s,\-\-silent
- Like \-\-quiet, but also suppresses the 'in directory' announcement.
-.TP
-.BR \-T,\-\-tasks
- Display the tasks and dependencies, then exit.
-.TP
-.BR \-t,\-\-trace
- Turn on invoke/execute tracing, enable full backtrace.
-.TP
-.BR \-h,\-\-usage
- Display usage.
-.TP
-.BR \-v,\-\-verbose
- Log message to standard output (default).
-.TP
-.BR \-V,\-\-version
- Display the program version.
-
-.\".SH "RETURN VALUE"
-.\"What the program or function returns if successful.
-.\".SH ERRORS
-.\"Return codes, either exit status or errno settings.
-.\".SH EXAMPLES
-.\"Give some example uses of the program.
-.SH AUTHOR
-Manpage provided by Adam Majer as part of the Debian's rake
-package. Upstream author of rake is Jim Weirich.
-.SH "SEE ALSO"
-.\" Always quote multiple words for .SH
-Full documentation is available in /usr/share/doc/rake/html
diff --git a/debian/rake.manpages b/debian/rake.manpages
index e86dd99..332fda5 100644
--- a/debian/rake.manpages
+++ b/debian/rake.manpages
@@ -1 +1 @@
-debian/rake.1
+doc/rake.1
--
Alioth's /usr/local/bin/git-commit-notice on /srv/git.debian.org/git/pkg-ruby-extras/rake.git
More information about the Pkg-ruby-extras-commits
mailing list