Skip to content

Commit

Permalink
docs: blockdev: add it to the admin-guide
Browse files Browse the repository at this point in the history
The blockdev book basically contains user-faced documentation.

Signed-off-by: Mauro Carvalho Chehab <mchehab+samsung@kernel.org>
  • Loading branch information
Mauro Carvalho Chehab committed Jul 15, 2019
1 parent 330d481 commit e775161
Show file tree
Hide file tree
Showing 22 changed files with 24 additions and 26 deletions.
File renamed without changes.
File renamed without changes.
Original file line number Diff line number Diff line change
Expand Up @@ -11,4 +11,3 @@ digraph peer_states {
Unknown -> Primary [ label = "connected" ]
Unknown -> Secondary [ label = "connected" ]
}

File renamed without changes.
Original file line number Diff line number Diff line change
@@ -1,5 +1,3 @@
:orphan:

===========================
The Linux RapidIO Subsystem
===========================
Expand Down
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
1 change: 1 addition & 0 deletions Documentation/admin-guide/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -73,6 +73,7 @@ configure specific aspects of kernel behavior to your liking.
java
ras
bcache
blockdev/index
ext4
binderfs
pm/index
Expand Down
18 changes: 9 additions & 9 deletions Documentation/admin-guide/kernel-parameters.txt
Original file line number Diff line number Diff line change
Expand Up @@ -1249,7 +1249,7 @@
See also Documentation/fault-injection/.

floppy= [HW]
See Documentation/blockdev/floppy.rst.
See Documentation/admin-guide/blockdev/floppy.rst.

force_pal_cache_flush
[IA-64] Avoid check_sal_cache_flush which may hang on
Expand Down Expand Up @@ -2234,7 +2234,7 @@
memblock=debug [KNL] Enable memblock debug messages.

load_ramdisk= [RAM] List of ramdisks to load from floppy
See Documentation/blockdev/ramdisk.rst.
See Documentation/admin-guide/blockdev/ramdisk.rst.

lockd.nlm_grace_period=P [NFS] Assign grace period.
Format: <integer>
Expand Down Expand Up @@ -3268,7 +3268,7 @@

pcd. [PARIDE]
See header of drivers/block/paride/pcd.c.
See also Documentation/blockdev/paride.rst.
See also Documentation/admin-guide/blockdev/paride.rst.

pci=option[,option...] [PCI] various PCI subsystem options.

Expand Down Expand Up @@ -3512,7 +3512,7 @@
needed on a platform with proper driver support.

pd. [PARIDE]
See Documentation/blockdev/paride.rst.
See Documentation/admin-guide/blockdev/paride.rst.

pdcchassis= [PARISC,HW] Disable/Enable PDC Chassis Status codes at
boot time.
Expand All @@ -3527,10 +3527,10 @@
and performance comparison.

pf. [PARIDE]
See Documentation/blockdev/paride.rst.
See Documentation/admin-guide/blockdev/paride.rst.

pg. [PARIDE]
See Documentation/blockdev/paride.rst.
See Documentation/admin-guide/blockdev/paride.rst.

pirq= [SMP,APIC] Manual mp-table setup
See Documentation/x86/i386/IO-APIC.rst.
Expand Down Expand Up @@ -3642,7 +3642,7 @@

prompt_ramdisk= [RAM] List of RAM disks to prompt for floppy disk
before loading.
See Documentation/blockdev/ramdisk.rst.
See Documentation/admin-guide/blockdev/ramdisk.rst.

psi= [KNL] Enable or disable pressure stall information
tracking.
Expand All @@ -3664,7 +3664,7 @@
pstore.backend= Specify the name of the pstore backend to use

pt. [PARIDE]
See Documentation/blockdev/paride.rst.
See Documentation/admin-guide/blockdev/paride.rst.

pti= [X86_64] Control Page Table Isolation of user and
kernel address spaces. Disabling this feature
Expand Down Expand Up @@ -3693,7 +3693,7 @@
See Documentation/admin-guide/md.rst.

ramdisk_size= [RAM] Sizes of RAM disks in kilobytes
See Documentation/blockdev/ramdisk.rst.
See Documentation/admin-guide/blockdev/ramdisk.rst.

random.trust_cpu={on,off}
[KNL] Enable or disable trusting the use of the
Expand Down
10 changes: 5 additions & 5 deletions MAINTAINERS
Original file line number Diff line number Diff line change
Expand Up @@ -5006,7 +5006,7 @@ T: git git://git.linbit.com/drbd-8.4.git
S: Supported
F: drivers/block/drbd/
F: lib/lru_cache.c
F: Documentation/blockdev/drbd/
F: Documentation/admin-guide/blockdev/

DRIVER CORE, KOBJECTS, DEBUGFS AND SYSFS
M: Greg Kroah-Hartman <gregkh@linuxfoundation.org>
Expand Down Expand Up @@ -11076,7 +11076,7 @@ M: Josef Bacik <josef@toxicpanda.com>
S: Maintained
L: linux-block@vger.kernel.org
L: nbd@other.debian.org
F: Documentation/blockdev/nbd.rst
F: Documentation/admin-guide/blockdev/nbd.rst
F: drivers/block/nbd.c
F: include/trace/events/nbd.h
F: include/uapi/linux/nbd.h
Expand Down Expand Up @@ -12086,7 +12086,7 @@ PARIDE DRIVERS FOR PARALLEL PORT IDE DEVICES
M: Tim Waugh <tim@cyberelk.net>
L: linux-parport@lists.infradead.org (subscribers-only)
S: Maintained
F: Documentation/blockdev/paride.rst
F: Documentation/admin-guide/blockdev/paride.rst
F: drivers/block/paride/

PARISC ARCHITECTURE
Expand Down Expand Up @@ -13367,7 +13367,7 @@ F: drivers/net/wireless/ralink/rt2x00/
RAMDISK RAM BLOCK DEVICE DRIVER
M: Jens Axboe <axboe@kernel.dk>
S: Maintained
F: Documentation/blockdev/ramdisk.rst
F: Documentation/admin-guide/blockdev/ramdisk.rst
F: drivers/block/brd.c

RANCHU VIRTUAL BOARD FOR MIPS
Expand Down Expand Up @@ -17723,7 +17723,7 @@ R: Sergey Senozhatsky <sergey.senozhatsky.work@gmail.com>
L: linux-kernel@vger.kernel.org
S: Maintained
F: drivers/block/zram/
F: Documentation/blockdev/zram.rst
F: Documentation/admin-guide/blockdev/zram.rst

ZS DECSTATION Z85C30 SERIAL DRIVER
M: "Maciej W. Rozycki" <macro@linux-mips.org>
Expand Down
8 changes: 4 additions & 4 deletions drivers/block/Kconfig
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@ config BLK_DEV_FD
If you want to use the floppy disk drive(s) of your PC under Linux,
say Y. Information about this driver, especially important for IBM
Thinkpad users, is contained in
<file:Documentation/blockdev/floppy.rst>.
<file:Documentation/admin-guide/blockdev/floppy.rst>.
That file also contains the location of the Floppy driver FAQ as
well as location of the fdutils package used to configure additional
parameters of the driver at run time.
Expand Down Expand Up @@ -96,7 +96,7 @@ config PARIDE
your computer's parallel port. Most of them are actually IDE devices
using a parallel port IDE adapter. This option enables the PARIDE
subsystem which contains drivers for many of these external drives.
Read <file:Documentation/blockdev/paride.rst> for more information.
Read <file:Documentation/admin-guide/blockdev/paride.rst> for more information.

If you have said Y to the "Parallel-port support" configuration
option, you may share a single port between your printer and other
Expand Down Expand Up @@ -261,7 +261,7 @@ config BLK_DEV_NBD
userland (making server and client physically the same computer,
communicating using the loopback network device).

Read <file:Documentation/blockdev/nbd.rst> for more information,
Read <file:Documentation/admin-guide/blockdev/nbd.rst> for more information,
especially about where to find the server code, which runs in user
space and does not need special kernel support.

Expand Down Expand Up @@ -303,7 +303,7 @@ config BLK_DEV_RAM
during the initial install of Linux.

Note that the kernel command line option "ramdisk=XX" is now obsolete.
For details, read <file:Documentation/blockdev/ramdisk.rst>.
For details, read <file:Documentation/admin-guide/blockdev/ramdisk.rst>.

To compile this driver as a module, choose M here: the
module will be called brd. An alias "rd" has been defined
Expand Down
2 changes: 1 addition & 1 deletion drivers/block/floppy.c
Original file line number Diff line number Diff line change
Expand Up @@ -4424,7 +4424,7 @@ static int __init floppy_setup(char *str)
pr_cont("\n");
} else
DPRINT("botched floppy option\n");
DPRINT("Read Documentation/blockdev/floppy.rst\n");
DPRINT("Read Documentation/admin-guide/blockdev/floppy.rst\n");
return 0;
}

Expand Down
6 changes: 3 additions & 3 deletions drivers/block/zram/Kconfig
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ config ZRAM
It has several use cases, for example: /tmp storage, use as swap
disks and maybe many more.

See Documentation/blockdev/zram.rst for more information.
See Documentation/admin-guide/blockdev/zram.rst for more information.

config ZRAM_WRITEBACK
bool "Write back incompressible or idle page to backing device"
Expand All @@ -26,7 +26,7 @@ config ZRAM_WRITEBACK
With /sys/block/zramX/{idle,writeback}, application could ask
idle page's writeback to the backing device to save in memory.

See Documentation/blockdev/zram.rst for more information.
See Documentation/admin-guide/blockdev/zram.rst for more information.

config ZRAM_MEMORY_TRACKING
bool "Track zRam block status"
Expand All @@ -36,4 +36,4 @@ config ZRAM_MEMORY_TRACKING
of zRAM. Admin could see the information via
/sys/kernel/debug/zram/zramX/block_state.

See Documentation/blockdev/zram.rst for more information.
See Documentation/admin-guide/blockdev/zram.rst for more information.
2 changes: 1 addition & 1 deletion tools/testing/selftests/zram/README
Original file line number Diff line number Diff line change
Expand Up @@ -37,4 +37,4 @@ Commands required for testing:
- mkfs/ mkfs.ext4

For more information please refer:
kernel-source-tree/Documentation/blockdev/zram.rst
kernel-source-tree/Documentation/admin-guide/blockdev/zram.rst

0 comments on commit e775161

Please sign in to comment.