linux.git/Documentation/block, branch v5.2-rc2

block: null: Add documentation for "zone_nr_conv" param

2019-04-09T14:18:23+00:00

zone_nr_conv module parameter was introduced by a commit
ea2c18e1("null_blk: Add conventional zone configuration for zoned
support").

This patch describes "zone_nr_conv" module parameter to the document.

Reviewed-by: Chaitanya Kulkarni 
Signed-off-by: Minwoo Im 
Signed-off-by: Jens Axboe

doc, block, bfq: add information on bfq execution time

2019-04-01T14:15:40+00:00

The execution time of BFQ has been slightly lowered. Report the new
execution time in BFQ documentation.

Signed-off-by: Paolo Valente 
Signed-off-by: Jens Axboe

block: document usage of bio iterator helpers

2019-02-15T15:40:12+00:00

Now multi-page bvec is supported, some helpers may return page by
page, meantime some may return segment by segment, this patch
documents the usage.

Reviewed-by: Christoph Hellwig 
Reviewed-by: Omar Sandoval 
Signed-off-by: Ming Lei 
Signed-off-by: Jens Axboe

block: doc: add slice_idle_us to bfq documentation

2019-01-09T14:38:48+00:00

Of the tunables available for the bfq I/O scheduler, the only one
missing from the documentation in 'Documentation/block/bfq-iosched.txt'
is slice_idle_us. Add this tunable to the documentation and a short
explanation of its purpose.

Acked-by: Paolo Valente 
Signed-off-by: John Pittman 
Signed-off-by: Jens Axboe

null_blk: add zoned config support information

2019-01-06T17:58:27+00:00

If the kernel is built without CONFIG_BLK_DEV_ZONED, a modprobe
of the null_blk driver with zoned=1 fails with 'Invalid argument'.
This can be confusing to users, prompting a search as to why the
parameter is invalid. To assist in that search, add a bit more
information to the failure, additionally adding to the documentation
that CONFIG_BLK_DEV_ZONED is needed for zoned=1.

Reviewed-by: Bart Van Assche 
Signed-off-by: John Pittman 

Added null_blk prefix to error message.

Signed-off-by: Jens Axboe

block: add documentation for io_timeout

2019-01-05T02:19:51+00:00

Add documentation for /sys/block//queue/io_timeout.

Reviewed-by: Bart Van Assche 
Signed-off-by: Weiping Zhang 
Signed-off-by: Jens Axboe

block: update sysfs documentation

2018-12-17T02:53:06+00:00

Add the description of the zoned, nr_zones and chunk_sectors sysfs queue
attributes to Documentation/block/queue-sysfs.txt. The description of
the zoned and chunk_sector attributes are mostly copied from
ABI/testing/sysfs-block (added a typo fix). While at it, also fix a
typo in the description of the io_poll_delay attribute.

nr_zones description is also added to ABI/testing/sysfs-block and
contact email address updated for the zoned attribute.

Signed-off-by: Damien Le Moal 
Signed-off-by: Jens Axboe

block: remove legacy IO schedulers

2018-11-07T20:42:32+00:00

Retain the deadline documentation, as that carries over to mq-deadline
as well.

Tested-by: Ming Lei 
Reviewed-by: Omar Sandoval 
Signed-off-by: Jens Axboe

block: remove legacy rq tagging

2018-11-07T20:42:32+00:00

It's now unused, kill it.

Reviewed-by: Hannes Reinecke 
Tested-by: Ming Lei 
Reviewed-by: Omar Sandoval 
Signed-off-by: Jens Axboe

Drop all 00-INDEX files from Documentation/

2018-09-09T21:08:58+00:00

This is a respin with a wider audience (all that get_maintainer returned)
and I know this spams a *lot* of people. Not sure what would be the correct
way, so my apologies for ruining your inbox.

The 00-INDEX files are supposed to give a summary of all files present
in a directory, but these files are horribly out of date and their
usefulness is brought into question. Often a simple "ls" would reveal
the same information as the filenames are generally quite descriptive as
a short introduction to what the file covers (it should not surprise
anyone what Documentation/sched/sched-design-CFS.txt covers)

A few years back it was mentioned that these files were no longer really
needed, and they have since then grown further out of date, so perhaps
it is time to just throw them out.

A short status yields the following _outdated_ 00-INDEX files, first
counter is files listed in 00-INDEX but missing in the directory, last
is files present but not listed in 00-INDEX.

List of outdated 00-INDEX:
Documentation: (4/10)
Documentation/sysctl: (0/1)
Documentation/timers: (1/0)
Documentation/blockdev: (3/1)
Documentation/w1/slaves: (0/1)
Documentation/locking: (0/1)
Documentation/devicetree: (0/5)
Documentation/power: (1/1)
Documentation/powerpc: (0/5)
Documentation/arm: (1/0)
Documentation/x86: (0/9)
Documentation/x86/x86_64: (1/1)
Documentation/scsi: (4/4)
Documentation/filesystems: (2/9)
Documentation/filesystems/nfs: (0/2)
Documentation/cgroup-v1: (0/2)
Documentation/kbuild: (0/4)
Documentation/spi: (1/0)
Documentation/virtual/kvm: (1/0)
Documentation/scheduler: (0/2)
Documentation/fb: (0/1)
Documentation/block: (0/1)
Documentation/networking: (6/37)
Documentation/vm: (1/3)

Then there are 364 subdirectories in Documentation/ with several files that
are missing 00-INDEX alltogether (and another 120 with a single file and no
00-INDEX).

I don't really have an opinion to whether or not we /should/ have 00-INDEX,
but the above 00-INDEX should either be removed or be kept up to date. If
we should keep the files, I can try to keep them updated, but I rather not
if we just want to delete them anyway.

As a starting point, remove all index-files and references to 00-INDEX and
see where the discussion is going.

Signed-off-by: Henrik Austad 
Acked-by: "Paul E. McKenney" 
Just-do-it-by: Steven Rostedt 
Reviewed-by: Jens Axboe 
Acked-by: Paul Moore 
Acked-by: Greg Kroah-Hartman 
Acked-by: Mark Brown 
Acked-by: Mike Rapoport 
Cc: [Almost everybody else]
Signed-off-by: Jonathan Corbet