All of lore.kernel.org
 help / color / mirror / Atom feed
From: "Michael Kerrisk (man-pages)" <mtk.manpages-Re5JQEeQqe8AvxtiuMwx3w@public.gmane.org>
To: coreutils-mXXj517/zsQ@public.gmane.org
Cc: mtk.manpages-Re5JQEeQqe8AvxtiuMwx3w@public.gmane.org,
	Jim Meyering <jim-Oxw1nKZkIVjk1uMJSBkQmQ@public.gmane.org>,
	"linux-man-u79uwXL29TY76Z2rM5mHXA@public.gmane.org"
	<linux-man-u79uwXL29TY76Z2rM5mHXA@public.gmane.org>
Subject: sync man page in coreutils and man-pages
Date: Mon, 10 Mar 2014 13:03:41 +0100	[thread overview]
Message-ID: <531DAA1D.6060705@gmail.com> (raw)

Hi,

Sometime in the 20th century (before my watch), a sync(8)
page made its way into the Linux man-pages set that I maintain
(http://man7.org/linux/man-pages/man8/sync.8.html). It purportedly
documents the sync command from fileutils, which gives an idea
of its age, and the piece under notes notes some behavior of sync(2)
that ceased to be true many years ago.

The man-pages project generally focuses on only Linux kernel and
(g)libc interfaces, so this sync(8) page doesn't really belong,
and I would like to remove it. Also, I see that coreutils has a 
sync(1) page which covers the same command. However, I see that
that page lacks some details that are in the sync(8) page. Before
I retire the sync(8) page, would you be interested to integrate 
any of the following detail into the coreutils sync(1) page?

       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.

       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.)

Cheers,

Michael

-- 
Michael Kerrisk
Linux man-pages maintainer; http://www.kernel.org/doc/man-pages/
Linux/UNIX System Programming Training: http://man7.org/training/
--
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

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

Thread overview: 5+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2014-03-10 12:03 Michael Kerrisk (man-pages) [this message]
     [not found] ` <531DAA1D.6060705-Re5JQEeQqe8AvxtiuMwx3w@public.gmane.org>
2014-03-10 12:10   ` sync man page in coreutils and man-pages 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
     [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=531DAA1D.6060705@gmail.com \
    --to=mtk.manpages-re5jqeeqqe8avxtiumwx3w@public.gmane.org \
    --cc=coreutils-mXXj517/zsQ@public.gmane.org \
    --cc=jim-Oxw1nKZkIVjk1uMJSBkQmQ@public.gmane.org \
    --cc=linux-man-u79uwXL29TY76Z2rM5mHXA@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.