All of lore.kernel.org
 help / color / mirror / Atom feed
From: "Stéphane Aulery" <saulery-GANU6spQydw@public.gmane.org>
To: "Michael Kerrisk (man-pages)"
	<mtk.manpages-Re5JQEeQqe8AvxtiuMwx3w@public.gmane.org>
Cc: linux-man-u79uwXL29TY76Z2rM5mHXA@public.gmane.org
Subject: Re: undocumented man pages
Date: Sun, 8 Mar 2015 12:12:40 +0100	[thread overview]
Message-ID: <20150308111240.GA1839@free.fr> (raw)
In-Reply-To: <54FC0369.3010705-Re5JQEeQqe8AvxtiuMwx3w@public.gmane.org>

Hello Michael,

Le dimanche 08 mars 2015 à 09:08:09, Michael Kerrisk (man-pages) a écrit :
> 
> On 03/07/2015 03:57 PM, Stéphane Aulery wrote:
> > 
> > What do you think about to add a "undocumented" page for each section (as
> > undocumented.3) and create each missing pages with a reference to the
> > appropriate "undocumented" page. Thus we can also encourage users to become
> > contributors and avoid unnecessary reports.
> 
> My problem with this idea is that my simple test when wondering if
> a man page exists for an API is to look in the appropriate man?/ 
> directory for a file with the right name. With the scheme above, I then
> need to look inside the file to see if it is a link to undocumented.x.
> That would be a small inconvenience.

How is obtained the list of missing pages? Another solution would be to
provide a script that generates the missing pages with the redirection.

> Yes, the reports about missing pages are a minor irritation, but I'm
> a little doubtful that such an "undocumented" page would encourage much
> contribution. (I could be wrong, that's just my guess.)

I too could be wrong. I'm probably too optimistic. I feel that if the
user sees clearly that the page is not yet written and needs of its
contribution, it is better information for him and a better chance for
us.

PS: Thank you for patches, you are very responsive !

Cheers,

-- 
Stéphane Aulery
--
To unsubscribe from this list: send the line "unsubscribe linux-man" in
the body of a message to majordomo-u79uwXL29TY76Z2rM5mHXA@public.gmane.org
More majordomo info at  http://vger.kernel.org/majordomo-info.html

  parent reply	other threads:[~2015-03-08 11:12 UTC|newest]

Thread overview: 5+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2015-03-07 14:57 undocumented man pages Stéphane Aulery
     [not found] ` <20150307145716.GA24297-GANU6spQydw@public.gmane.org>
2015-03-08  8:08   ` Michael Kerrisk (man-pages)
     [not found]     ` <54FC0369.3010705-Re5JQEeQqe8AvxtiuMwx3w@public.gmane.org>
2015-03-08 11:12       ` Stéphane Aulery [this message]
     [not found]         ` <20150308111240.GA1839-GANU6spQydw@public.gmane.org>
2015-03-09  7:06           ` Michael Kerrisk (man-pages)
     [not found]             ` <CAKgNAkhvGtPMwq1kdf-ZJZ=FNGQqLjHuyakgbaUqLbdhAueL-A-JsoAwUIsXosN+BqQ9rBEUg@public.gmane.org>
2015-03-09  8:10               ` Stéphane Aulery

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=20150308111240.GA1839@free.fr \
    --to=saulery-ganu6spqydw@public.gmane.org \
    --cc=linux-man-u79uwXL29TY76Z2rM5mHXA@public.gmane.org \
    --cc=mtk.manpages-Re5JQEeQqe8AvxtiuMwx3w@public.gmane.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 an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.