Commit Graph

28 Commits

Author SHA1 Message Date
Jakub Wilk 1973affe18 blockdev: fix man page formatting
Signed-off-by: Jakub Wilk <jwilk@jwilk.net>
2020-09-26 18:15:42 +02:00
Michael Kerrisk (man-pages) 76054e1527 Manual pages: blockdev.8, sfdisk.8: typo fixes
Fix a couple of typos that I introduced.

Signed-off-by: Michael Kerrisk (man-pages) <mtk.manpages@gmail.com>
2020-08-28 09:15:25 +02:00
Michael Kerrisk (man-pages) 342af74630 Manual pages: blockdev.8: Minor wording and formatting fixes
Signed-off-by: Michael Kerrisk (man-pages) <mtk.manpages@gmail.com>
2020-07-24 14:41:49 +02:00
Michael Kerrisk (man-pages) a8d0d330cf Manual pages: Standardize on AUTHORS as section title
There is quite some value (in terms of readability and user
expectations) if consistent names are used for the sections
within manual pages. This patch is one of a series to bring
about this consistency.

In the Linux man-pages project, I long ago did away with the
AUTHOR(S) section, but I realize some projects like to keep this.

But, let's make sure that the section is consistently titled
across pages. Currently we have AUTHOR (47) or AUTHORS (41).
Let's standardize on the latter (which is also what is
suggested in man-pages(7)).

Signed-off-by: Michael Kerrisk <mtk.manpages@gmail.com>
2020-05-20 12:56:12 +02:00
Karel Zak c9fbfcfc49 blockdev: make –-getbsz less confusing for end-users
Addresses: https://bugzilla.redhat.com/show_bug.cgi?id=1684078
Signed-off-by: Karel Zak <kzak@redhat.com>
2019-02-28 14:08:23 +01:00
Karel Zak aae7bfc8b7 blockdev: be more explicit for BLKSSZ in blockdev.8
Addresses: https://github.com/karelzak/util-linux/issues/535
Signed-off-by: Karel Zak <kzak@redhat.com>
2017-11-13 12:15:17 +01:00
Karel Zak 80701a7ace blockdev: document --setro more properly
Addresses: https://github.com/karelzak/util-linux/issues/498
Signed-off-by: Karel Zak <kzak@redhat.com>
2017-08-14 11:30:37 +02:00
Ruediger Meier a861538cc8 blockdev: improve --help and man page
Signed-off-by: Ruediger Meier <ruediger.meier@ga-group.nl>
2017-06-27 12:28:44 +02:00
Sébastien Helleu d673b74e9d docs: replace FTP by HTTPS in kernel.org URLs
The links to ftp://ftp.kernel.org/ are replaced by
https://www.kernel.org/.

Signed-off-by: Karel Zak <kzak@redhat.com>
2016-12-19 11:22:26 +01:00
Sebastian Rasmussen d35df4db5b docs: Fix various typos
Signed-off-by: Sebastian Rasmussen <sebras@gmail.com>
2016-05-31 23:40:21 +02:00
Benno Schulenberg 3a60b1c26b docs: remove obsolete and unneeded comments from man-page files
Transform some of them into copyright lines.
Also fix three header lines and snip some trailing whitespace.

Signed-off-by: Benno Schulenberg <bensberg@justemail.net>
2015-01-12 11:03:26 +01:00
Bjarni Ingi Gislason 023dcba0f0 blockdev: Some minor corrections to the manual
Macro, that alternately changes the input between two font styles,
changed to the macro for one font style change, if there is only one
argument

 Text string, that begins or ends with a full stop (.) protected with \&

 -- changed to \-\- if it is an option

 - changed to \(en if it is a dash (pause, seperation)


Signed-off-by: Karel Zak <kzak@redhat.com>
2014-04-07 12:18:04 +02:00
Karel Zak 7ab32ae64d blockdev: add note about --setbsz usability
Signed-off-by: Karel Zak <kzak@redhat.com>
2013-10-11 11:16:23 +02:00
Karel Zak 39d2e7067d Revert "blockdev: Remove the --setbsz (set blocksize) option which has never worked."
This reverts commit b1555acc2f.

It seems that the option is used by kernel guys to test kernel, so
let's keep the option in the blockdev(8) although it's almost useless
in userspace. All we need is to improve docs to make things more
obvious to end users.

Signed-off-by: Karel Zak <kzak@redhat.com>
2013-10-11 11:05:45 +02:00
Richard W.M. Jones b1555acc2f blockdev: Remove the --setbsz (set blocksize) option which has never worked.
This option has never worked.  If you try setting the block size on a
block device, and then read it using --getbsz, you will see that the
block size never changes.

The reason for this is because the block size is specific to the
current file descriptor opening the block device, so the change of
block size only persists for as long as blockdev has the device open,
and is lost once blockdev exits.

Also the block size is not really used anywhere.  Filesystems, for
example, have their own idea of block size and ignore this setting
completely.

(Thanks Masayoshi Mizuma for diagnosing the problem)

Signed-off-by: Richard W.M. Jones <rjones@redhat.com>
2013-10-08 15:48:00 +02:00
Benno Schulenberg 232dc924c4 docs: uniformize the header and footer lines in man pages
Use dates without the day, use the full month name, put "util-linux" in
the lower left corner, and "User Commands" or "System Administration"
at the top center.

Also improve here and there the one-line program description.

Signed-off-by: Benno Schulenberg <bensberg@justemail.net>
2011-08-22 10:39:21 +02:00
Davidlohr Bueso 16493c3e0f disk-utils: fix manpage typos
Signed-off-by: Davidlohr Bueso <dave@gnu.org>
2011-01-17 15:27:29 +01:00
Karel Zak 601d12fb10 rename util-linux-ng back to util-linux
Signed-off-by: Karel Zak <kzak@redhat.com>
2010-11-30 11:41:59 +01:00
Karel Zak 8f83100949 blockdev: fix typo in blockdev.8
Reported-by: Marcos Felipe Rasia de Mello <marcosfrm@gmail.com>
Signed-off-by: Karel Zak <kzak@redhat.com>
2010-08-28 00:50:24 +02:00
Karel Zak 455fdf4af8 blockdev: sync man page with code
Signed-off-by: Karel Zak <kzak@redhat.com>
2010-08-24 12:59:41 +02:00
Peter Breitenlohner feae57c9e5 blockdev.8: formatting
Signed-off-by: Peter Breitenlohner <peb@mppmu.mpg.de>
2009-08-17 12:11:09 +02:00
Karel Zak 010d0a4cca blockdev: add note that the StartSec is in 512-byte sectors
Signed-off-by: Karel Zak <kzak@redhat.com>
2009-02-26 15:58:28 +01:00
Karel Zak 7dcca505f8 blockdev: add --getsz to blockdev.8
This patch also marks --getsize as deprecated option.

Signed-off-by: Karel Zak <kzak@redhat.com>
2007-11-28 20:55:45 +01:00
Li Zefan 45be3f7d8d blockdev: add missing description about option --report in manpage
The manpage does not mention the option --report.

Signed-off-by: Li Zefan <lizf@cn.fujitsu.com>
2007-09-19 23:14:09 +02:00
Karel Zak 86d62711a9 man pages: add "AVAILABILITY" section
Signed-off-by: Karel Zak <kzak@redhat.com>
2007-07-03 01:17:04 +02:00
Karel Zak a424171cd1 blockdev: cleanup usage() and update man page
Signed-off-by: Karel Zak <kzak@redhat.com>
2007-06-29 12:06:58 +02:00
Karel Zak c2a1e78808 blockdev: add BLKFRAGET/BLKFRASET ioctls
In Linux 2.6 the BLKRASET ioctl has the desired effect for mounted
file-systems.  In Linux 2.4 it appears to set the number of blocks to
read-ahead on the *device* as opposed to within a *file*, and the
maximum value of this number is 255.  As a result the invocation of
blockdev will fail on Linux 2.4 for any usefully large value of
READAHEAD, and will not in any case have the desired affect for
fragmented files.

(Based on the blockdev-getfra-setfra.patch Debian patch.)

Signed-off-by: Karel Zak <kzak@redhat.com>
2007-06-29 11:38:54 +02:00
Karel Zak 66ee8158b6 Imported from util-linux-2.10s tarball. 2006-12-07 00:25:44 +01:00