projects/linux·commit 05ef8b97

Merge tag 'docs-5.6' of git://git.lwn.net/linux

05ef8b97 · Linus Torvalds <[email protected]> · 2020-01-29 15:27:31 -08:00

Pull documentation updates from Jonathan Corbet:
 "It has been a relatively quiet cycle for documentation, but there's
  still a couple of things of note:

   - Conversion of the NFS documentation to RST

   - A new document on how to help with documentation (and a maintainer
     profile entry too)

  Plus the usual collection of typo fixes, etc"

* tag 'docs-5.6' of git://git.lwn.net/linux: (40 commits)
  docs: filesystems: add overlayfs to index.rst
  docs: usb: remove some broken references
  scripts/find-unused-docs: Fix massive false positives
  docs: nvdimm: use ReST notation for subsection
  zram: correct documentation about sysfs node of huge page writeback
  Documentation: zram: various fixes in zram.rst
  Add a maintainer entry profile for documentation
  Add a document on how to contribute to the documentation
  docs: Keep up with the location of NoUri
  Documentation: Call out example SYM_FUNC_* usage as x86-specific
  Documentation: nfs: fault_injection: convert to ReST
  Documentation: nfs: pnfs-scsi-server: convert to ReST
  Documentation: nfs: convert pnfs-block-server to ReST
  Documentation: nfs: idmapper: convert to ReST
  Documentation: convert nfsd-admin-interfaces to ReST
  Documentation: nfs-rdma: convert to ReST
  Documentation: nfsroot.rst: COSMETIC: refill a paragraph
  Documentation: nfsroot.txt: convert to ReST
  Documentation: convert nfs.txt to ReST
  Documentation: filesystems: convert vfat.txt to RST
  ...
Commit
05ef8b97ddf9aed40df977477daeab01760d7f9a
Parents
08a3ef8f · 77ce1a47

Merge commit. Changes below are compared with the first parent: 08a3ef8f.

Changes

42 files changed · +1655 −622

FileStatusAddDelContent
Documentation/admin-guide/blockdev/zram.rstmodified+32−31View file
Documentation/admin-guide/index.rstmodified+1−0View file
Documentation/filesystems/nfs/fault_injection.txt → Documentation/admin-guide/nfs/fault_injection.rstrenamed+3−2View file
Documentation/admin-guide/nfs/index.rstadded+15−0View file
Documentation/filesystems/nfs/nfs.txt → Documentation/admin-guide/nfs/nfs-client.rstrenamed+45−40View file
Documentation/filesystems/nfs/idmapper.txt → Documentation/admin-guide/nfs/nfs-idmapper.rstrenamed+17−14View file
Documentation/filesystems/nfs/nfs-rdma.txt → Documentation/admin-guide/nfs/nfs-rdma.rstrenamed+173−155View file
Documentation/filesystems/nfs/nfsd-admin-interfaces.txt → Documentation/admin-guide/nfs/nfsd-admin-interfaces.rstrenamed+9−10View file
Documentation/filesystems/nfs/nfsroot.txt → Documentation/admin-guide/nfs/nfsroot.rstrenamed+80−71View file
Documentation/filesystems/nfs/pnfs-block-server.txt → Documentation/admin-guide/nfs/pnfs-block-server.rstrenamed+15−10View file
Documentation/filesystems/nfs/pnfs-scsi-server.txt → Documentation/admin-guide/nfs/pnfs-scsi-server.rstrenamed+1−0View file
Documentation/asm-annotations.rstmodified+5−4View file
Documentation/block/biovecs.rstmodified+1−1View file
Documentation/doc-guide/contributing.rstadded+294−0View file
Documentation/doc-guide/index.rstmodified+2−0View file
Documentation/doc-guide/maintainer-profile.rstadded+44−0View file
Documentation/filesystems/automount-support.txtmodified+1−1View file
Documentation/filesystems/index.rstmodified+2−0View file
Documentation/filesystems/vfat.txt → Documentation/filesystems/vfat.rstrenamed+258−218View file
Documentation/kernel-hacking/hacking.rstmodified+2−2View file
Documentation/locking/locktorture.rstmodified+1−2View file
Documentation/maintainer/maintainer-entry-profile.rstmodified+1−0View file
Documentation/misc-devices/xilinx_sdfec.rstmodified+1−0View file
Documentation/nvdimm/maintainer-entry-profile.rstmodified+2−1View file
Documentation/process/embargoed-hardware-issues.rstmodified+15−10View file
Documentation/riscv/boot-image-header.rstmodified+2−2View file
Documentation/sphinx/automarkup.pymodified+6−1View file
Documentation/trace/ftrace.rstmodified+12−6View file
Documentation/trace/ring-buffer-design.txtmodified+1−1View file
Documentation/translations/ko_KR/memory-barriers.txtmodified+2−2View file
Documentation/translations/zh_CN/process/embargoed-hardware-issues.rstadded+228−0View file
Documentation/translations/zh_CN/process/index.rstmodified+3−0View file
Documentation/translations/zh_CN/process/kernel-driver-statement.rstadded+199−0View file
Documentation/translations/zh_CN/process/kernel-enforcement-statement.rstadded+151−0View file
Documentation/usb/index.rstmodified+0−2View file
Documentation/usb/text_files.rstmodified+0−6View file
Documentation/w1/masters/omap-hdq.rstmodified+1−1View file
Documentation/x86/boot.rstmodified+23−22View file
Documentation/x86/x86_64/mm.rstmodified+3−3View file
MAINTAINERSmodified+1−1View file
arch/riscv/include/asm/image.hmodified+2−2View file
scripts/find-unused-docs.shmodified+1−1View file

Only the first 600 diff lines are shown. Download the complete patch.

Documentation/admin-guide/blockdev/zram.rst

View file
diff --git a/Documentation/admin-guide/blockdev/zram.rst b/Documentation/admin-guide/blockdev/zram.rst
index 6eccf13..27c77d8 100644
--- a/Documentation/admin-guide/blockdev/zram.rst
+++ b/Documentation/admin-guide/blockdev/zram.rst
@@ -1,15 +1,15 @@
========================================
-zram: Compressed RAM based block devices
+zram: Compressed RAM-based block devices
========================================
Introduction
============
-The zram module creates RAM based block devices named /dev/zram<id>
+The zram module creates RAM-based block devices named /dev/zram<id>
(<id> = 0, 1, ...). Pages written to these disks are compressed and stored
in memory itself. These disks allow very fast I/O and compression provides
-good amounts of memory savings. Some of the usecases include /tmp storage,
-use as swap disks, various caches under /var and maybe many more :)
+good amounts of memory savings. Some of the use cases include /tmp storage,
+use as swap disks, various caches under /var and maybe many more. :)
Statistics for individual zram devices are exported through sysfs nodes at
/sys/block/zram<id>/
@@ -43,17 +43,17 @@ The list of possible return codes:
======== =============================================================
-EBUSY an attempt to modify an attribute that cannot be changed once
- the device has been initialised. Please reset device first;
+ the device has been initialised. Please reset device first.
-ENOMEM zram was not able to allocate enough memory to fulfil your
- needs;
+ needs.
-EINVAL invalid input has been provided.
======== =============================================================
-If you use 'echo', the returned value that is changed by 'echo' utility,
+If you use 'echo', the returned value is set by the 'echo' utility,
and, in general case, something like::
echo 3 > /sys/block/zram0/max_comp_streams
- if [ $? -ne 0 ];
+ if [ $? -ne 0 ]; then
handle_error
fi
@@ -65,7 +65,8 @@ should suffice.
::
modprobe zram num_devices=4
- This creates 4 devices: /dev/zram{0,1,2,3}
+
+This creates 4 devices: /dev/zram{0,1,2,3}
num_devices parameter is optional and tells zram how many devices should be
pre-created. Default: 1.
@@ -73,12 +74,12 @@ pre-created. Default: 1.
2) Set max number of compression streams
========================================
-Regardless the value passed to this attribute, ZRAM will always
-allocate multiple compression streams - one per online CPUs - thus
+Regardless of the value passed to this attribute, ZRAM will always
+allocate multiple compression streams - one per online CPU - thus
allowing several concurrent compression operations. The number of
allocated compression streams goes down when some of the CPUs
become offline. There is no single-compression-stream mode anymore,
-unless you are running a UP system or has only 1 CPU online.
+unless you are running a UP system or have only 1 CPU online.
To find out how many streams are currently available::
@@ -89,7 +90,7 @@ To find out how many streams are currently available::
Using comp_algorithm device attribute one can see available and
currently selected (shown in square brackets) compression algorithms,
-change selected compression algorithm (once the device is initialised
+or change the selected compression algorithm (once the device is initialised
there is no way to change compression algorithm).
Examples::
@@ -167,9 +168,9 @@ Examples::
zram provides a control interface, which enables dynamic (on-demand) device
addition and removal.
-In order to add a new /dev/zramX device, perform read operation on hot_add
-attribute. This will return either new device's device id (meaning that you
-can use /dev/zram<id>) or error code.
+In order to add a new /dev/zramX device, perform a read operation on the hot_add
+attribute. This will return either the new device's device id (meaning that you
+can use /dev/zram<id>) or an error code.
Example::
@@ -186,8 +187,8 @@ execute::
Per-device statistics are exported as various nodes under /sys/block/zram<id>/
-A brief description of exported device attributes. For more details please
-read Documentation/ABI/testing/sysfs-block-zram.
+A brief description of exported device attributes follows. For more details
+please read Documentation/ABI/testing/sysfs-block-zram.
====================== ====== ===============================================
Name access description
@@ -245,7 +246,7 @@ whitespace:
File /sys/block/zram<id>/mm_stat
-The stat file represents device's mm statistics. It consists of a single
+The mm_stat file represents the device's mm statistics. It consists of a single
line of text and contains the following stats separated by whitespace:
================ =============================================================
@@ -261,7 +262,7 @@ line of text and contains the following stats separated by whitespace:
Unit: bytes
mem_limit the maximum amount of memory ZRAM can use to store
the compressed data
- mem_used_max the maximum amount of memory zram have consumed to
+ mem_used_max the maximum amount of memory zram has consumed to
store the data
same_pages the number of same element filled pages written to this disk.
No memory is allocated for such pages.
@@ -271,7 +272,7 @@ line of text and contains the following stats separated by whitespace:
File /sys/block/zram<id>/bd_stat
-The stat file represents device's backing device statistics. It consists of
+The bd_stat file represents a device's backing device statistics. It consists of
a single line of text and contains the following stats separated by whitespace:
============== =============================================================
@@ -316,9 +317,9 @@ To use the feature, admin should set up backing device via::
echo /dev/sda5 > /sys/block/zramX/backing_dev
before disksize setting. It supports only partition at this moment.
-If admin want to use incompressible page writeback, they could do via::
+If admin wants to use incompressible page writeback, they could do via::
- echo huge > /sys/block/zramX/write
+ echo huge > /sys/block/zramX/writeback
To use idle page writeback, first, user need to declare zram pages
as idle::
@@ -326,7 +327,7 @@ as idle::
echo all > /sys/block/zramX/idle
From now on, any pages on zram are idle pages. The idle mark
-will be removed until someone request access of the block.
+will be removed until someone requests access of the block.
IOW, unless there is access request, those pages are still idle pages.
Admin can request writeback of those idle pages at right timing via::
@@ -341,16 +342,16 @@ to guarantee storage health for entire product life.
To overcome the concern, zram supports "writeback_limit" feature.
The "writeback_limit_enable"'s default value is 0 so that it doesn't limit
-any writeback. IOW, if admin want to apply writeback budget, he should
+any writeback. IOW, if admin wants to apply writeback budget, he should
enable writeback_limit_enable via::
$ echo 1 > /sys/block/zramX/writeback_limit_enable
Once writeback_limit_enable is set, zram doesn't allow any writeback
-until admin set the budget via /sys/block/zramX/writeback_limit.
+until admin sets the budget via /sys/block/zramX/writeback_limit.
(If admin doesn't enable writeback_limit_enable, writeback_limit's value
-assigned via /sys/block/zramX/writeback_limit is meaninless.)
+assigned via /sys/block/zramX/writeback_limit is meaningless.)
If admin want to limit writeback as per-day 400M, he could do it
like below::
@@ -361,13 +362,13 @@ like below::
/sys/block/zram0/writeback_limit.
$ echo 1 > /sys/block/zram0/writeback_limit_enable
-If admin want to allow further write again once the bugdet is exausted,
+If admins want to allow further write again once the bugdet is exhausted,
he could do it like below::
$ echo $((400<<MB_SHIFT>>4K_SHIFT)) > \
/sys/block/zram0/writeback_limit
-If admin want to see remaining writeback budget since he set::
+If admin wants to see remaining writeback budget since last set::
$ cat /sys/block/zramX/writeback_limit
@@ -375,12 +376,12 @@ If admin want to disable writeback limit, he could do::
$ echo 0 > /sys/block/zramX/writeback_limit_enable
-The writeback_limit count will reset whenever you reset zram(e.g.,
+The writeback_limit count will reset whenever you reset zram (e.g.,
system reboot, echo 1 > /sys/block/zramX/reset) so keeping how many of
writeback happened until you reset the zram to allocate extra writeback
budget in next setting is user's job.
-If admin want to measure writeback count in a certain period, he could
+If admin wants to measure writeback count in a certain period, he could
know it via /sys/block/zram0/bd_stat's 3rd column.
memory tracking

Documentation/admin-guide/index.rst

View file
diff --git a/Documentation/admin-guide/index.rst b/Documentation/admin-guide/index.rst
index 4405b74..4433f39 100644
--- a/Documentation/admin-guide/index.rst
+++ b/Documentation/admin-guide/index.rst
@@ -76,6 +76,7 @@ configure specific aspects of kernel behavior to your liking.
device-mapper/index
efi-stub
ext4
+ nfs/index
gpio/index
highuid
hw_random

Documentation/admin-guide/nfs/fault_injection.rst

View file
diff --git a/Documentation/filesystems/nfs/fault_injection.txt b/Documentation/admin-guide/nfs/fault_injection.rst
similarity index 95%
rename from Documentation/filesystems/nfs/fault_injection.txt
rename to Documentation/admin-guide/nfs/fault_injection.rst
index f3a5b0a..eb029c0 100644
--- a/Documentation/filesystems/nfs/fault_injection.txt
+++ b/Documentation/admin-guide/nfs/fault_injection.rst
@@ -1,6 +1,7 @@
+===================
+NFS Fault Injection
+===================
-Fault Injection
-===============
Fault injection is a method for forcing errors that may not normally occur, or
may be difficult to reproduce. Forcing these errors in a controlled environment
can help the developer find and fix bugs before their code is shipped in a

Documentation/admin-guide/nfs/index.rst

View file
diff --git a/Documentation/admin-guide/nfs/index.rst b/Documentation/admin-guide/nfs/index.rst
new file mode 100644
index 0000000..6b5a3c9
--- /dev/null
+++ b/Documentation/admin-guide/nfs/index.rst
@@ -0,0 +1,15 @@
+=============
+NFS
+=============
+
+.. toctree::
+ :maxdepth: 1
+
+ nfs-client
+ nfsroot
+ nfs-rdma
+ nfsd-admin-interfaces
+ nfs-idmapper
+ pnfs-block-server
+ pnfs-scsi-server
+ fault_injection

Documentation/admin-guide/nfs/nfs-client.rst

View file
diff --git a/Documentation/filesystems/nfs/nfs.txt b/Documentation/admin-guide/nfs/nfs-client.rst
similarity index 92%
rename from Documentation/filesystems/nfs/nfs.txt
rename to Documentation/admin-guide/nfs/nfs-client.rst
index f2571c8..c4b777c 100644
--- a/Documentation/filesystems/nfs/nfs.txt
+++ b/Documentation/admin-guide/nfs/nfs-client.rst
@@ -1,3 +1,6 @@
+==========
+NFS Client
+==========
The NFS client
==============
@@ -59,10 +62,11 @@ The DNS resolver
NFSv4 allows for one server to refer the NFS client to data that has been
migrated onto another server by means of the special "fs_locations"
-attribute. See
- http://tools.ietf.org/html/rfc3530#section-6
-and
- http://tools.ietf.org/html/draft-ietf-nfsv4-referrals-00
+attribute. See `RFC3530 Section 6: Filesystem Migration and Replication`_ and
+`Implementation Guide for Referrals in NFSv4`_.
+
+.. _RFC3530 Section 6\: Filesystem Migration and Replication: http://tools.ietf.org/html/rfc3530#section-6
+.. _Implementation Guide for Referrals in NFSv4: http://tools.ietf.org/html/draft-ietf-nfsv4-referrals-00
The fs_locations information can take the form of either an ip address and
a path, or a DNS hostname and a path. The latter requires the NFS client to
@@ -78,8 +82,8 @@ Assuming that the user has the 'rpc_pipefs' filesystem mounted in the usual
(2) If no valid entry exists, the helper script '/sbin/nfs_cache_getent'
(may be changed using the 'nfs.cache_getent' kernel boot parameter)
is run, with two arguments:
- - the cache name, "dns_resolve"
- - the hostname to resolve
+ - the cache name, "dns_resolve"
+ - the hostname to resolve
(3) After looking up the corresponding ip address, the helper script
writes the result into the rpc_pipefs pseudo-file
@@ -94,43 +98,44 @@ Assuming that the user has the 'rpc_pipefs' filesystem mounted in the usual
script, and <ttl> is the 'time to live' of this cache entry (in
units of seconds).
- Note: If <ip address> is invalid, say the string "0", then a negative
- entry is created, which will cause the kernel to treat the hostname
- as having no valid DNS translation.
+ .. note::
+ If <ip address> is invalid, say the string "0", then a negative
+ entry is created, which will cause the kernel to treat the hostname
+ as having no valid DNS translation.
A basic sample /sbin/nfs_cache_getent
=====================================
-
-#!/bin/bash
-#
-ttl=600
-#
-cut=/usr/bin/cut
-getent=/usr/bin/getent
-rpc_pipefs=/var/lib/nfs/rpc_pipefs
-#
-die()
-{
- echo "Usage: $0 cache_name entry_name"
- exit 1
-}
-
-[ $# -lt 2 ] && die
-cachename="$1"
-cache_path=${rpc_pipefs}/cache/${cachename}/channel
-
-case "${cachename}" in
- dns_resolve)
- name="$2"
- result="$(${getent} hosts ${name} | ${cut} -f1 -d\ )"
- [ -z "${result}" ] && result="0"
- ;;
- *)
- die
- ;;
-esac
-echo "${result} ${name} ${ttl}" >${cache_path}
-
+.. code-block:: sh
+
+ #!/bin/bash
+ #
+ ttl=600
+ #
+ cut=/usr/bin/cut
+ getent=/usr/bin/getent
+ rpc_pipefs=/var/lib/nfs/rpc_pipefs
+ #
+ die()
+ {
+ echo "Usage: $0 cache_name entry_name"
+ exit 1
+ }
+
+ [ $# -lt 2 ] && die
+ cachename="$1"
+ cache_path=${rpc_pipefs}/cache/${cachename}/channel
+
+ case "${cachename}" in
+ dns_resolve)
+ name="$2"
+ result="$(${getent} hosts ${name} | ${cut} -f1 -d\ )"
+ [ -z "${result}" ] && result="0"
+ ;;
+ *)
+ die
+ ;;
+ esac
+ echo "${result} ${name} ${ttl}" >${cache_path}

Documentation/admin-guide/nfs/nfs-idmapper.rst

View file
diff --git a/Documentation/filesystems/nfs/idmapper.txt b/Documentation/admin-guide/nfs/nfs-idmapper.rst
similarity index 76%
rename from Documentation/filesystems/nfs/idmapper.txt
rename to Documentation/admin-guide/nfs/nfs-idmapper.rst
index b86831a..58b8e63 100644
--- a/Documentation/filesystems/nfs/idmapper.txt
+++ b/Documentation/admin-guide/nfs/nfs-idmapper.rst
@@ -1,7 +1,7 @@
+=============
+NFS ID Mapper
+=============
-=========
-ID Mapper
-=========
Id mapper is used by NFS to translate user and group ids into names, and to
translate user and group names into ids. Part of this translation involves
performing an upcall to userspace to request the information. There are two
@@ -20,22 +20,24 @@ legacy rpc.idmap daemon for the id mapping. This result will be stored
in a custom NFS idmap cache.
-===========
Configuring
===========
+
The file /etc/request-key.conf will need to be modified so /sbin/request-key can
direct the upcall. The following line should be added:
-#OP TYPE DESCRIPTION CALLOUT INFO PROGRAM ARG1 ARG2 ARG3 ...
-#====== ======= =============== =============== ===============================
-create id_resolver * * /usr/sbin/nfs.idmap %k %d 600
+``#OP TYPE DESCRIPTION CALLOUT INFO PROGRAM ARG1 ARG2 ARG3 ...``
+``#====== ======= =============== =============== ===============================``
+``create id_resolver * * /usr/sbin/nfs.idmap %k %d 600``
+
This will direct all id_resolver requests to the program /usr/sbin/nfs.idmap.
The last parameter, 600, defines how many seconds into the future the key will
expire. This parameter is optional for /usr/sbin/nfs.idmap. When the timeout
is not specified, nfs.idmap will default to 600 seconds.
-id mapper uses for key descriptions:
+id mapper uses for key descriptions::
+
uid: Find the UID for the given user
gid: Find the GID for the given group
user: Find the user name for the given UID
@@ -45,23 +47,24 @@ You can handle any of these individually, rather than using the generic upcall
program. If you would like to use your own program for a uid lookup then you
would edit your request-key.conf so it look similar to this:
-#OP TYPE DESCRIPTION CALLOUT INFO PROGRAM ARG1 ARG2 ARG3 ...
-#====== ======= =============== =============== ===============================
-create id_resolver uid:* * /some/other/program %k %d 600
-create id_resolver * * /usr/sbin/nfs.idmap %k %d 600
+``#OP TYPE DESCRIPTION CALLOUT INFO PROGRAM ARG1 ARG2 ARG3 ...``
+``#====== ======= =============== =============== ===============================``
+``create id_resolver uid:* * /some/other/program %k %d 600``
+``create id_resolver * * /usr/sbin/nfs.idmap %k %d 600``
+
Notice that the new line was added above the line for the generic program.
request-key will find the first matching line and corresponding program. In
this case, /some/other/program will handle all uid lookups and
/usr/sbin/nfs.idmap will handle gid, user, and group lookups.
-See <file:Documentation/security/keys/request-key.rst> for more information
+See Documentation/security/keys/request-key.rst for more information
about the request-key function.
-=========
nfs.idmap
=========
+
nfs.idmap is designed to be called by request-key, and should not be run "by
hand". This program takes two arguments, a serialized key and a key
description. The serialized key is first converted into a key_serial_t, and

Documentation/admin-guide/nfs/nfs-rdma.rst

View file
diff --git a/Documentation/filesystems/nfs/nfs-rdma.txt b/Documentation/admin-guide/nfs/nfs-rdma.rst
similarity index 67%
rename from Documentation/filesystems/nfs/nfs-rdma.txt
rename to Documentation/admin-guide/nfs/nfs-rdma.rst
index 22dc0dd..ef0f367 100644
--- a/Documentation/filesystems/nfs/nfs-rdma.txt
+++ b/Documentation/admin-guide/nfs/nfs-rdma.rst
@@ -1,191 +1,192 @@
-################################################################################
-# #
-# NFS/RDMA README #
-# #
-################################################################################
-
- Author: NetApp and Open Grid Computing
- Date: May 29, 2008
-
-Table of Contents
-~~~~~~~~~~~~~~~~~
- - Overview
- - Getting Help
- - Installation
- - Check RDMA and NFS Setup
- - NFS/RDMA Setup
+===================
+Setting up NFS/RDMA
+===================
-Overview
-~~~~~~~~
+:Author:
+ NetApp and Open Grid Computing (May 29, 2008)
- This document describes how to install and setup the Linux NFS/RDMA client
- and server software.
+.. warning::
+ This document is probably obsolete.
- The NFS/RDMA client was first included in Linux 2.6.24. The NFS/RDMA server
- was first included in the following release, Linux 2.6.25.
+Overview
+========
- In our testing, we have obtained excellent performance results (full 10Gbit
- wire bandwidth at minimal client CPU) under many workloads. The code passes
- the full Connectathon test suite and operates over both Infiniband and iWARP
- RDMA adapters.
+This document describes how to install and setup the Linux NFS/RDMA client
+and server software.
-Getting Help
-~~~~~~~~~~~~
+The NFS/RDMA client was first included in Linux 2.6.24. The NFS/RDMA server
+was first included in the following release, Linux 2.6.25.
- If you get stuck, you can ask questions on the
+In our testing, we have obtained excellent performance results (full 10Gbit
+wire bandwidth at minimal client CPU) under many workloads. The code passes
+the full Connectathon test suite and operates over both Infiniband and iWARP
+RDMA adapters.
+Getting Help
+============
- mailing list.
+If you get stuck, you can ask questions on the
[email protected] mailing list.
Installation
-~~~~~~~~~~~~
+============
+
+These instructions are a step by step guide to building a machine for
+use with NFS/RDMA.
- These instructions are a step by step guide to building a machine for
- use with NFS/RDMA.
+- Install an RDMA device
- - Install an RDMA device
+ Any device supported by the drivers in drivers/infiniband/hw is acceptable.
- Any device supported by the drivers in drivers/infiniband/hw is acceptable.
+ Testing has been performed using several Mellanox-based IB cards, the
+ Ammasso AMS1100 iWARP adapter, and the Chelsio cxgb3 iWARP adapter.
- Testing has been performed using several Mellanox-based IB cards, the
- Ammasso AMS1100 iWARP adapter, and the Chelsio cxgb3 iWARP adapter.
+- Install a Linux distribution and tools
- - Install a Linux distribution and tools
+ The first kernel release to contain both the NFS/RDMA client and server was
+ Linux 2.6.25 Therefore, a distribution compatible with this and subsequent
+ Linux kernel release should be installed.
- The first kernel release to contain both the NFS/RDMA client and server was
- Linux 2.6.25 Therefore, a distribution compatible with this and subsequent
- Linux kernel release should be installed.
+ The procedures described in this document have been tested with
+ distributions from Red Hat's Fedora Project (http://fedora.redhat.com/).
- The procedures described in this document have been tested with
- distributions from Red Hat's Fedora Project (http://fedora.redhat.com/).
+- Install nfs-utils-1.1.2 or greater on the client
- - Install nfs-utils-1.1.2 or greater on the client
+ An NFS/RDMA mount point can be obtained by using the mount.nfs command in
+ nfs-utils-1.1.2 or greater (nfs-utils-1.1.1 was the first nfs-utils
+ version with support for NFS/RDMA mounts, but for various reasons we
+ recommend using nfs-utils-1.1.2 or greater). To see which version of
+ mount.nfs you are using, type:
- An NFS/RDMA mount point can be obtained by using the mount.nfs command in
- nfs-utils-1.1.2 or greater (nfs-utils-1.1.1 was the first nfs-utils
- version with support for NFS/RDMA mounts, but for various reasons we
- recommend using nfs-utils-1.1.2 or greater). To see which version of
- mount.nfs you are using, type:
+ .. code-block:: sh
$ /sbin/mount.nfs -V
- If the version is less than 1.1.2 or the command does not exist,
- you should install the latest version of nfs-utils.
+ If the version is less than 1.1.2 or the command does not exist,
+ you should install the latest version of nfs-utils.
- Download the latest package from:
+ Download the latest package from: http://www.kernel.org/pub/linux/utils/nfs
- http://www.kernel.org/pub/linux/utils/nfs
+ Uncompress the package and follow the installation instructions.
- Uncompress the package and follow the installation instructions.
+ If you will not need the idmapper and gssd executables (you do not need
+ these to create an NFS/RDMA enabled mount command), the installation
+ process can be simplified by disabling these features when running
+ configure:
- If you will not need the idmapper and gssd executables (you do not need
- these to create an NFS/RDMA enabled mount command), the installation
- process can be simplified by disabling these features when running
- configure:
+ .. code-block:: sh
$ ./configure --disable-gss --disable-nfsv4

This diff is incomplete. Download the complete patch.

Documentation/admin-guide/nfs/nfsd-admin-interfaces.rst

View file

This diff is incomplete. Download the complete patch.

Documentation/admin-guide/nfs/nfsroot.rst

View file

This diff is incomplete. Download the complete patch.

Documentation/admin-guide/nfs/pnfs-block-server.rst

View file

This diff is incomplete. Download the complete patch.

Documentation/admin-guide/nfs/pnfs-scsi-server.rst

View file

This diff is incomplete. Download the complete patch.

Documentation/asm-annotations.rst

View file

This diff is incomplete. Download the complete patch.

Documentation/block/biovecs.rst

View file

This diff is incomplete. Download the complete patch.

Documentation/doc-guide/contributing.rst

View file

This diff is incomplete. Download the complete patch.

Documentation/doc-guide/index.rst

View file

This diff is incomplete. Download the complete patch.

Documentation/doc-guide/maintainer-profile.rst

View file

This diff is incomplete. Download the complete patch.

Documentation/filesystems/automount-support.txt

View file

This diff is incomplete. Download the complete patch.

Documentation/filesystems/index.rst

View file

This diff is incomplete. Download the complete patch.

Documentation/filesystems/vfat.rst

View file

This diff is incomplete. Download the complete patch.

Documentation/kernel-hacking/hacking.rst

View file

This diff is incomplete. Download the complete patch.

Documentation/locking/locktorture.rst

View file

This diff is incomplete. Download the complete patch.

Documentation/maintainer/maintainer-entry-profile.rst

View file

This diff is incomplete. Download the complete patch.

Documentation/misc-devices/xilinx_sdfec.rst

View file

This diff is incomplete. Download the complete patch.

Documentation/nvdimm/maintainer-entry-profile.rst

View file

This diff is incomplete. Download the complete patch.

Documentation/process/embargoed-hardware-issues.rst

View file

This diff is incomplete. Download the complete patch.

Documentation/riscv/boot-image-header.rst

View file

This diff is incomplete. Download the complete patch.

Documentation/sphinx/automarkup.py

View file

This diff is incomplete. Download the complete patch.

Documentation/trace/ftrace.rst

View file

This diff is incomplete. Download the complete patch.

Documentation/trace/ring-buffer-design.txt

View file

This diff is incomplete. Download the complete patch.

Documentation/translations/ko_KR/memory-barriers.txt

View file

This diff is incomplete. Download the complete patch.

Documentation/translations/zh_CN/process/embargoed-hardware-issues.rst

View file

This diff is incomplete. Download the complete patch.

Documentation/translations/zh_CN/process/index.rst

View file

This diff is incomplete. Download the complete patch.

Documentation/translations/zh_CN/process/kernel-driver-statement.rst

View file

This diff is incomplete. Download the complete patch.

Documentation/translations/zh_CN/process/kernel-enforcement-statement.rst

View file

This diff is incomplete. Download the complete patch.

Documentation/usb/index.rst

View file

This diff is incomplete. Download the complete patch.

Documentation/usb/text_files.rst

View file

This diff is incomplete. Download the complete patch.

Documentation/w1/masters/omap-hdq.rst

View file

This diff is incomplete. Download the complete patch.

Documentation/x86/boot.rst

View file

This diff is incomplete. Download the complete patch.

Documentation/x86/x86_64/mm.rst

View file

This diff is incomplete. Download the complete patch.

MAINTAINERS

View file

This diff is incomplete. Download the complete patch.

arch/riscv/include/asm/image.h

View file

This diff is incomplete. Download the complete patch.

scripts/find-unused-docs.sh

View file

This diff is incomplete. Download the complete patch.