NFS/RDMA: Document separate Kconfig symbols
Subsystems (3)
PATCH 1/1 NFS/RDMA: Document separate Kconfig symbols
The NFS/RDMA Kconfig symbol was split into separate options for client and server in commit 2e8c12e1b765 ("xprtrdma: add separate Kconfig options for NFSoRDMA client and server support"). Update the documentation to reflect this split.
---
0) Should Documentation/ describe the current release, or the current and previous releases? For these paragraphs I choose only the current release.
1) Another approach could be to not document the Kconfig setup at all, because the Kconfig system should, in theory, provide all help needed to correctly configure the build for (in this case) NFS/RDMA. But is that true?
2) By the way: what's the purpose of INFINIBAND_ADDR_TRANS?
Documentation/filesystems/nfs/nfs-rdma.txt | 16 +++++++++------- 1 file changed, 9 insertions(+), 7 deletions(-)
Documentation/filesystems/nfs/nfs-rdma.txt +9 -7
@@ -138,9 +138,9 @@ Installation - Build, install, reboot The NFS/RDMA code will be enabled automatically if NFS and RDMA - are turned on. The NFS/RDMA client and server are configured via the hidden - SUNRPC_XPRT_RDMA config option that depends on SUNRPC and INFINIBAND. The - value of SUNRPC_XPRT_RDMA will be: + are turned on. The NFS/RDMA client and server are configured via the + SUNRPC_XPRT_RDMA_CLIENT and SUNRPC_XPRT_RDMA_SERVER config options that both + depend on SUNRPC and INFINIBAND. The default value of both options will be: - N if either SUNRPC or INFINIBAND are N, in this case the NFS/RDMA client and server will not be built
@@ -235,8 +235,9 @@ NFS/RDMA Setup - Start the NFS server - If the NFS/RDMA server was built as a module (CONFIG_SUNRPC_XPRT_RDMA=m in - kernel config), load the RDMA transport module: + If the NFS/RDMA server was built as a module + (CONFIG_SUNRPC_XPRT_RDMA_SERVER=m in kernel config), load the RDMA + transport module: $ modprobe svcrdma
@@ -255,8 +256,9 @@ NFS/RDMA Setup - On the client system - If the NFS/RDMA client was built as a module (CONFIG_SUNRPC_XPRT_RDMA=m in - kernel config), load the RDMA client module: + If the NFS/RDMA client was built as a module + (CONFIG_SUNRPC_XPRT_RDMA_CLIENT=m in kernel config), load the RDMA client + module: $ modprobe xprtrdma.ko
Signature · 1 line
1.9.0
Quoted 11 lines · On Wed, 09 Apr 2014 16:05:53 +0200 Paul Bolle <[email protected]> wrote:
The NFS/RDMA
Kconfigsymbol was split into separate options for client and server in commit2e8c12e1b765("xprtrdma: add separateKconfigoptions for NFSoRDMA client and server support"). Update the documentation to reflect this split.Signed-off-by Paul Bolle <[email protected]>---
0) ShouldDocumentation/describe the current release, or the current and previous releases? For these paragraphs I choose only the current release.
I think they're only relevant for the tree they're in. The docs are shipped with the kernel sources, after all, so presumably someone who is looking at these has docs that match their kernel (my omission notwithstanding, of course)
Quoted 5 lines
1) Another approach could be to not document the
Kconfigsetup at all, because theKconfigsystem should, in theory, provide all help needed to correctly configure the build for (in this case) NFS/RDMA. But is that true?
Yeah, it does seem somewhat redundant.
Quoted 36 lines
2) By the way: what's the purpose of
INFINIBAND_ADDR_TRANS?Documentation/filesystems/nfs/nfs-rdma.txt | 16 +++++++++------- 1 file changed, 9 insertions(+), 7 deletions(-)Documentation/filesystems/nfs/nfs-rdma.txt +6
-5@@ -138,9 +138,9 @@ Installation - Build, install, reboot The NFS/RDMA code will be enabled automatically if NFS and RDMA - are turned on. The NFS/RDMA client and server are configured via the hidden - SUNRPC_XPRT_RDMA config option that depends on SUNRPC and INFINIBAND. The - value of SUNRPC_XPRT_RDMA will be: + are turned on. The NFS/RDMA client and server are configured via the + SUNRPC_XPRT_RDMA_CLIENT and SUNRPC_XPRT_RDMA_SERVER config options that both + depend on SUNRPC and INFINIBAND. The default value of both options will be: - N if either SUNRPC or INFINIBAND are N, in this case the NFS/RDMA client and server will not be built@@ -235,8 +235,9 @@ NFS/RDMA Setup - Start the NFS server - If the NFS/RDMA server was built as a module (CONFIG_SUNRPC_XPRT_RDMA=m in - kernel config), load the RDMA transport module: + If the NFS/RDMA server was built as a module + (CONFIG_SUNRPC_XPRT_RDMA_SERVER=m in kernel config), load the RDMA + transport module: $ modprobe svcrdma@@ -255,8 +256,9 @@ NFS/RDMA Setup
Documentation/filesystems/nfs/nfs-rdma.txt NFS/RDMA Setup · line 264
Quoted 10 lines
Documentation/filesystems/nfs/nfs-rdma.txt +3
-2- On the client system - If the NFS/RDMA client was built as a module (CONFIG_SUNRPC_XPRT_RDMA=m in - kernel config), load the RDMA client module: + If the NFS/RDMA client was built as a module + (CONFIG_SUNRPC_XPRT_RDMA_CLIENT=m in kernel config), load the RDMA client + module: $ modprobe xprtrdma.ko
Thanks, nice catch, I had forgotten about the docs...
Randy,
Quoted 72 lines · Jeff Layton
Quoted 11 lines · On Wed, 09 Apr 2014 16:05:53 +0200 Paul Bolle <[email protected]> wrote:
The NFS/RDMA
Kconfigsymbol was split into separate options for client and server in commit2e8c12e1b765("xprtrdma: add separateKconfigoptions for NFSoRDMA client and server support"). Update the documentation to reflect this split.Signed-off-by Paul Bolle <[email protected]>---
0) ShouldDocumentation/describe the current release, or the current and previous releases? For these paragraphs I choose only the current release.I think they're only relevant for the tree they're in. The docs are shipped with the kernel sources, after all, so presumably someone who is looking at these has docs that match their kernel (my omission notwithstanding, of course)
Quoted 5 lines
1) Another approach could be to not document the
Kconfigsetup at all, because theKconfigsystem should, in theory, provide all help needed to correctly configure the build for (in this case) NFS/RDMA. But is that true?Yeah, it does seem somewhat redundant.
Quoted 44 lines
2) By the way: what's the purpose of
INFINIBAND_ADDR_TRANS?Documentation/filesystems/nfs/nfs-rdma.txt | 16 +++++++++------- 1 file changed, 9 insertions(+), 7 deletions(-)Documentation/filesystems/nfs/nfs-rdma.txt +9
-7@@ -138,9 +138,9 @@ Installation - Build, install, reboot The NFS/RDMA code will be enabled automatically if NFS and RDMA - are turned on. The NFS/RDMA client and server are configured via the hidden - SUNRPC_XPRT_RDMA config option that depends on SUNRPC and INFINIBAND. The - value of SUNRPC_XPRT_RDMA will be: + are turned on. The NFS/RDMA client and server are configured via the + SUNRPC_XPRT_RDMA_CLIENT and SUNRPC_XPRT_RDMA_SERVER config options that both + depend on SUNRPC and INFINIBAND. The default value of both options will be: - N if either SUNRPC or INFINIBAND are N, in this case the NFS/RDMA client and server will not be built@@ -235,8 +235,9 @@ NFS/RDMA Setup - Start the NFS server - If the NFS/RDMA server was built as a module (CONFIG_SUNRPC_XPRT_RDMA=m in - kernel config), load the RDMA transport module: + If the NFS/RDMA server was built as a module + (CONFIG_SUNRPC_XPRT_RDMA_SERVER=m in kernel config), load the RDMA + transport module: $ modprobe svcrdma@@ -255,8 +256,9 @@ NFS/RDMA Setup - On the client system - If the NFS/RDMA client was built as a module (CONFIG_SUNRPC_XPRT_RDMA=m in - kernel config), load the RDMA client module: + If the NFS/RDMA client was built as a module + (CONFIG_SUNRPC_XPRT_RDMA_CLIENT=m in kernel config), load the RDMA client + module:
Quoted 6 lines
Documentation/filesystems/nfs/nfs-rdma.txt NFS/RDMA Setup · line 264
Quoted 2 lines
Documentation/filesystems/nfs/nfs-rdma.txt +0
-0$ modprobe xprtrdma.koThanks, nice catch, I had forgotten about the docs...
Reviewed-by Jeff Layton <[email protected]>
It seems nothing ever happened after this. Can you take this patch? Or should I resend it with Jeff's Reviewed-by added?
Paul Bolle
Randy Dunlap
reviewerQuoted 80 lines · Paul Bolle
Randy,
Quoted 77 lines · Jeff Layton
Quoted 11 lines · On Wed, 09 Apr 2014 16:05:53 +0200 Paul Bolle <[email protected]> wrote:
The NFS/RDMA
Kconfigsymbol was split into separate options for client and server in commit2e8c12e1b765("xprtrdma: add separateKconfigoptions for NFSoRDMA client and server support"). Update the documentation to reflect this split.Signed-off-by Paul Bolle <[email protected]>---
0) ShouldDocumentation/describe the current release, or the current and previous releases? For these paragraphs I choose only the current release.I think they're only relevant for the tree they're in. The docs are shipped with the kernel sources, after all, so presumably someone who is looking at these has docs that match their kernel (my omission notwithstanding, of course)
Quoted 5 lines
1) Another approach could be to not document the
Kconfigsetup at all, because theKconfigsystem should, in theory, provide all help needed to correctly configure the build for (in this case) NFS/RDMA. But is that true?Yeah, it does seem somewhat redundant.
Quoted 36 lines
2) By the way: what's the purpose of
INFINIBAND_ADDR_TRANS?Documentation/filesystems/nfs/nfs-rdma.txt | 16 +++++++++------- 1 file changed, 9 insertions(+), 7 deletions(-)Documentation/filesystems/nfs/nfs-rdma.txt +6
-5@@ -138,9 +138,9 @@ Installation - Build, install, reboot The NFS/RDMA code will be enabled automatically if NFS and RDMA - are turned on. The NFS/RDMA client and server are configured via the hidden - SUNRPC_XPRT_RDMA config option that depends on SUNRPC and INFINIBAND. The - value of SUNRPC_XPRT_RDMA will be: + are turned on. The NFS/RDMA client and server are configured via the + SUNRPC_XPRT_RDMA_CLIENT and SUNRPC_XPRT_RDMA_SERVER config options that both + depend on SUNRPC and INFINIBAND. The default value of both options will be: - N if either SUNRPC or INFINIBAND are N, in this case the NFS/RDMA client and server will not be built@@ -235,8 +235,9 @@ NFS/RDMA Setup - Start the NFS server - If the NFS/RDMA server was built as a module (CONFIG_SUNRPC_XPRT_RDMA=m in - kernel config), load the RDMA transport module: + If the NFS/RDMA server was built as a module + (CONFIG_SUNRPC_XPRT_RDMA_SERVER=m in kernel config), load the RDMA + transport module: $ modprobe svcrdma@@ -255,8 +256,9 @@ NFS/RDMA SetupDocumentation/filesystems/nfs/nfs-rdma.txt NFS/RDMA Setup · line 264
Quoted 10 lines
Documentation/filesystems/nfs/nfs-rdma.txt +3
-2- On the client system - If the NFS/RDMA client was built as a module (CONFIG_SUNRPC_XPRT_RDMA=m in - kernel config), load the RDMA client module: + If the NFS/RDMA client was built as a module + (CONFIG_SUNRPC_XPRT_RDMA_CLIENT=m in kernel config), load the RDMA client + module: $ modprobe xprtrdma.koThanks, nice catch, I had forgotten about the docs...
Quoted 4 lines
Quoted 1 line
Reviewed-by Jeff Layton <[email protected]>It seems nothing ever happened after this. Can you take this patch? Or should I resend it with Jeff's Reviewed-by added?
I can add Jeff's Reviewed-by.
I'll merge it. Thanks.
Signature · 1 line
~Randy