Linux Manual Pages development
 help / color / mirror / Atom feed
From: "Pádraig Brady" <P@draigBrady.com>
To: "Michael Kerrisk (man-pages)"
	<mtk.manpages-Re5JQEeQqe8AvxtiuMwx3w@public.gmane.org>
Cc: Christoph Hellwig <hch-wEGCiKHe2LqWVfeAwA7xHQ@public.gmane.org>,
	"linux-man-u79uwXL29TY76Z2rM5mHXA@public.gmane.org"
	<linux-man-u79uwXL29TY76Z2rM5mHXA@public.gmane.org>,
	coreutils-mXXj517/zsQ@public.gmane.org
Subject: Re: sync man page in coreutils and man-pages
Date: Mon, 10 Mar 2014 12:34:24 +0000	[thread overview]
Message-ID: <531DB150.5090301@draigBrady.com> (raw)
In-Reply-To: <20140310121010.GA31927-wEGCiKHe2LqWVfeAwA7xHQ@public.gmane.org>

On 03/10/2014 12:10 PM, Christoph Hellwig wrote:
> On Mon, Mar 10, 2014 at 01:03:41PM +0100, Michael Kerrisk (man-pages) wrote:
>>        The  kernel  keeps  data  in  memory to avoid doing (relatively
>>        slow) disk reads and writes.  This improves performance, but if
>>        the  computer crashes, data may be lost or the file system cor???
>>        rupted as a result.  sync ensures that everything in memory  is
>>        written to disk.
> 
> This part looks correct.

Yes, and it's already in the info pages:
http://www.gnu.org/software/coreutils/manual/coreutils.html#sync-invocation

Generally we keep the man pages to a minimum,
stating the interface and brief description.
Users are prompted to run info coreutils 'sync invocation'
for further discussion, where they'll see the above text.

> 
>>        sync  should  be  called  before  the processor is halted in an
>>        unusual manner (e.g., before causing a kernel panic when debug???
>>        ging  new  kernel  code).   In general, the processor should be
>>        halted using the shutdown(8) or reboot(8) or halt(8)  commands,
>>        which  will  attempt  to  put  the  system in a quiescent state
>>        before calling sync(2).  (Various implementations of these com???
>>        mands  exist;  consult  your documentation; on some systems one
>>        should not call reboot(8) and halt(8) directly.)
> 
> This kind of information does not seem useful for a user of a command
> line utility, and the last bit seems incorrect at least for Linux.

I agree.

thanks,
Pádraig.

  parent reply	other threads:[~2014-03-10 12:34 UTC|newest]

Thread overview: 5+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2014-03-10 12:03 sync man page in coreutils and man-pages Michael Kerrisk (man-pages)
     [not found] ` <531DAA1D.6060705-Re5JQEeQqe8AvxtiuMwx3w@public.gmane.org>
2014-03-10 12:10   ` Christoph Hellwig
     [not found]     ` <20140310121010.GA31927-wEGCiKHe2LqWVfeAwA7xHQ@public.gmane.org>
2014-03-10 12:31       ` Michael Kerrisk (man-pages)
2014-03-10 12:34       ` Pádraig Brady [this message]
     [not found]         ` <531DB150.5090301-V8g9lnOeT5ydJdNcDFJN0w@public.gmane.org>
2014-03-10 14:25           ` Michael Kerrisk (man-pages)

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=531DB150.5090301@draigBrady.com \
    --to=p@draigbrady.com \
    --cc=coreutils-mXXj517/zsQ@public.gmane.org \
    --cc=hch-wEGCiKHe2LqWVfeAwA7xHQ@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 a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox