diff options
author | Michael Kerrisk <mtk.manpages@gmail.com> | 2020-12-02 10:22:56 +0100 |
---|---|---|
committer | Michael Kerrisk <mtk.manpages@gmail.com> | 2020-12-02 11:29:14 +0100 |
commit | 38f293795cde2a7e32524b08c591ba612853137f (patch) | |
tree | 112baf17c023e6b34463eaddcd2384440e2a8227 | |
parent | 0859838e1c03c4e64e993a7cebd3c811d74a5430 (diff) |
Tweak various pages to indicate that there's a comaintainerv2020-12-02
Signed-off-by: Michael Kerrisk <mtk.manpages@gmail.com>
-rw-r--r-- | contributing.html | 3 | ||||
-rw-r--r-- | licenses.html | 2 | ||||
-rw-r--r-- | linux-api-ml.html | 6 | ||||
-rw-r--r-- | maintaining.html | 25 | ||||
-rw-r--r-- | missing_pages.html | 27 | ||||
-rw-r--r-- | patches.html | 36 | ||||
-rw-r--r-- | reporting_bugs.html | 18 | ||||
-rw-r--r-- | todo.html | 2 |
8 files changed, 50 insertions, 69 deletions
diff --git a/contributing.html b/contributing.html index 0100026..b0b8ec3 100644 --- a/contributing.html +++ b/contributing.html @@ -101,9 +101,6 @@ contributing | Review can include checking technical accuracy, and suggestions for improved wording, grammar, layout, and so on. - (This is an area where I especially need help. - As the project maintainer, I am far too often - the reviewer of last resort.) <br> <br> </li> diff --git a/licenses.html b/licenses.html index 5973b6c..c88b5d3 100644 --- a/licenses.html +++ b/licenses.html @@ -139,7 +139,7 @@ Subject: Re: [RFC v4] system_data_types.7: Document sigval, ssize_t, suseconds_t by including the following text at the top of the page source, and substituting the appropriate pieces. Licensing under GPLv2 is preferred, because so far only v2 of - the GPL is used in any man pages, and I'd prefer to avoid + the GPL is used in any man pages, and we'd prefer to avoid further license proliferation. </p> diff --git a/linux-api-ml.html b/linux-api-ml.html index 0f6d005..971b441 100644 --- a/linux-api-ml.html +++ b/linux-api-ml.html @@ -44,12 +44,10 @@ Linux <em>man-pages</em>: <p> Following a session (<a href="https://man7.org/conf/lpc2008/who_owns_the_interface.pdf">Who own's the interface</a>) - that I led at the 2008 Linux Plumbers Conference, + that led by Michael Kerrisk at the 2008 Linux Plumbers Conference, the <em>linux-api</em> mailing list (<span class="email">linux-api@vger.kernel.org</span>) - was - created at my request - as a forum to discuss + was created as a forum to discuss changes that affect the Linux programming interface</a> (API or ABI). </p> diff --git a/maintaining.html b/maintaining.html index 6bd9880..25cb8cd 100644 --- a/maintaining.html +++ b/maintaining.html @@ -46,11 +46,13 @@ Maintaining Linux <em>man-pages</em> The current <em>man-pages</em> maintainer is (since 2004) <a href="https://man7.org/mtk/">Michael Kerrisk</a> (<span class="email">mtk.manpages@gmail.com</span>; - <a href="https://blog.man7.org/">blog</a>). + <a href="https://blog.man7.org/">blog</a>); + starting in 2020, Alejandro Colomar + (<span class="email">alx.manpages@gmail.com</span>) + has joined as comaintainer. </p> <p> - One day, someone else will be the maintainer. - So, to make life easier for the next person: + This page provides some tips on how to maintain the Linux <em>man-pages</em> project (also useful for anyone who wants to help with work on <em>man-pages</em>). @@ -185,7 +187,7 @@ Maintaining Linux <em>man-pages</em> One of the biggest challenges is keeping up to date with changes in the kernel and glibc. There are a few ways to do this. - This section lists the things I find most useful. + This section lists some of the most useful ways. </p> @@ -246,8 +248,8 @@ Maintaining Linux <em>man-pages</em> Below are some other ways of trying to discover changes in the kernel and glibc. There's way too much information here to track (in particular, it's pretty much impossible to track all of - of the mailing lists), but I keep this list as a way - of reminding myself of where useful pieces of info could be found. + of the mailing lists), but the list below serves as a reminder of + some places where useful information could be found. </p> <h3>Looking ahead: <em>linux-next</em></h3> @@ -609,15 +611,6 @@ subscribe linux-net in the message body to majordomo@vger.kernel.org -<h4>Other</h4> - - <p> - Perhaps some other distributions have similar facilities, - but these are the - only ones I know about so far. - </p> - - <h2>Testing new features</h2> <h3>Test programs</h3> @@ -831,7 +824,7 @@ subscribe linux-net in the message body to majordomo@vger.kernel.org and to a small group of people (e.g., maintainers, translators) who like to get notification of *every* <em>man-pages</em> release. - I manually maintain a list of those people. + I (mtk) manually maintain a list of those people. <br> <br> </li> diff --git a/missing_pages.html b/missing_pages.html index 0bf561e..3e0f988 100644 --- a/missing_pages.html +++ b/missing_pages.html @@ -42,17 +42,19 @@ Linux <em>man-pages</em>: <h1>Manual pages that are missing from Linux <em>man-pages</em></h1> <p> - Below is a list of pages that I would like - to see in the <em>man-pages</em> set. + Below is a list of pages that probably should be added + to the <em>man-pages</em> set. If you are thinking of writing one or more of these pages, then: </p> <ul> <li> - It might be wise to let me know in advance, just in case someone + It might be wise to let the + <a href="maintaining.html">maintainers</a> + know in advance, just in case someone else has started working on the page, or a related page. - I may also be able point you at useful sources of information for - the man page. + The maintainers may also be able point you at useful sources of + information for the man page. <br> <br> </li> @@ -107,18 +109,9 @@ Linux <em>man-pages</em>: </li> <li> - Send the page (inline, not as an attachment) to - <blockquote> - <span class="email">mtk.manpages@gmail.com</span> - (Please do <strong>not</strong> CC my - <span class="email">@man7.org</span> email address.) - </blockquote> - CC - <blockquote> - <span class="email">linux-man@vger.kernel.org</span> - (<a href="linux-man-ml.html"><em>no HTML mail please</em></a>) - </blockquote> - and CC any other interested parties, + Submit the page following the project guidelines for + <a href="patches.html">submitting patches</a>. + Be sure to CC any other interested parties, including any people that you know of who might be suitable reviewers for the page. <br> diff --git a/patches.html b/patches.html index 58515f6..11de178 100644 --- a/patches.html +++ b/patches.html @@ -48,27 +48,30 @@ patches | </p> <ul> <li> - Put <span class="email">mtk.manpages@gmail.com</span> in "To:". - (Please do <strong>not</strong> CC my - <span class="email">@man7.org</span> email address.) - </li> - <li> - Put <span class="email">linux-man@vger.kernel.org</span> into "CC:" + Put <span class="email">linux-man@vger.kernel.org</span> + into "To:" or "CC:" (<a href="linux-man-ml.html"><em>no HTML mail please</em></a>), </li> <li> Include the string "[patch]" in the subject line </li> + <li> + Include either or both comaintainers + (Alejandro Colomar <span class="email"><alx.manpages@gmail.com></span> + and + Michael Kerrisk <span class="email"><mtk.manpages@gmail.com></span>) + in "To:" or "CC:". + (Please do <strong>not</strong> CC mtk's + <span class="email">@man7.org</span> email address.) + </li> </ul> <p> - <strong>The above is the minimum needed to ensure that - there's some chance I'll see the patch.</strong> - (If you did that, and I do not respond, then ping the mail thread, - "replying to all". - Unfortunately, I get more mail than I can sometimes deal with, - and things do get lost.) + <strong>The above is the minimum needed so that someone + might respond to your patch.</strong> + (If you did that, and someone does not respond within a few days, + then ping the mail thread, "replying to all".) </p> <p> <strong>To make your patch even more useful</strong>, @@ -167,7 +170,7 @@ patches | <li> For <strong>trivial patches</strong>, - I use a number of keywords that are processed by + the project uses a number of keywords that are processed by scripts that automatically build the release changelogs. Please employ the following in the patch subject line, where appropriate: @@ -197,7 +200,8 @@ patches | </li> <li> - <strong>Some general tips</strong> on how to make my life easier: + <strong>Some general tips</strong> on how to make life easier + for the maintainers: <br> <br> </li> @@ -291,8 +295,8 @@ patches | <br> </li> <li> - You don't need to update the page timestamp (".TH" line). - My release scripts do that automatically. + You don't need to update the page timestamp (".TH" line); + the project release scripts do that automatically. </li> </ul> diff --git a/reporting_bugs.html b/reporting_bugs.html index 14d30c8..a0ca910 100644 --- a/reporting_bugs.html +++ b/reporting_bugs.html @@ -127,15 +127,11 @@ bugs | Simple one-line or two-line errors (typos, spelling, grammar, etc.), or HTML rendering problems in the <a href="https://man7.org/linux/man-pages/index.html">online pages</a> - can be reported by sending an email message to - <blockquote> - <span class="email">mtk.manpages@gmail.com</span> - (Please do <strong>not</strong> CC my - <span class="email">@man7.org</span> email address.) - and CC - <span class="email">linux-man@vger.kernel.org</span> - (<a href="linux-man-ml.html"><em>no HTML mail please</em></a>), - </blockquote> + can be reported by sending an email message to the + <a href="maintaining.html">maintainers</a> + and CCing + <span class="email">linux-man@vger.kernel.org</span> + (<a href="linux-man-ml.html"><em>no HTML mail please</em></a>), <strong>Please do not report such bugs via the bugzilla.</strong> @@ -182,8 +178,8 @@ bugs | </blockquote> </li> <li> - Send a message to - <span class="email">mtk.manpages@gmail.com</span> + Send a message to the + <a href="maintaining.html">maintainers</a> and CC <span class="email">linux-man@vger.kernel.org</span>. <br> @@ -138,7 +138,7 @@ Linux <em>man-pages</em>: 2 page would need to be carried through to the Section 3 page; inevitably, inconsistencies will arise. <blockquote> - <em>Note:</em> I am doubtful that the problem noted in + <em>Note:</em> I (mtk) am doubtful that the problem noted in the above point could be resolved via some "include" mechanism that includes relevant pieces from the Section 2 page into the Section 3 page. |