€•€      Œsphinx.addnodes”Œdocument”“”)”}”(Œ	rawsource”Œ ”Œchildren”]”(Œtranslations”ŒLanguagesNode”“”)”}”(hhh]”(h Œpending_xref”“”)”}”(hhh]”Œdocutils.nodes”ŒText”“”ŒChinese (Simplified)”…””}”Œparent”hsbaŒ
attributes”}”(Œids”]”Œclasses”]”Œnames”]”Œdupnames”]”Œbackrefs”]”Œ	refdomain”Œstd”Œreftype”Œdoc”Œ	reftarget”ŒA/translations/zh_CN/filesystems/nfs/nfsd-maintainer-entry-profile”Œmodname”NŒ	classname”NŒrefexplicit”ˆuŒtagname”hhhubh)”}”(hhh]”hŒChinese (Traditional)”…””}”hh2sbah}”(h]”h ]”h"]”h$]”h&]”Œ	refdomain”h)Œreftype”h+Œ	reftarget”ŒA/translations/zh_TW/filesystems/nfs/nfsd-maintainer-entry-profile”Œmodname”NŒ	classname”NŒrefexplicit”ˆuh1hhhubh)”}”(hhh]”hŒItalian”…””}”hhFsbah}”(h]”h ]”h"]”h$]”h&]”Œ	refdomain”h)Œreftype”h+Œ	reftarget”ŒA/translations/it_IT/filesystems/nfs/nfsd-maintainer-entry-profile”Œmodname”NŒ	classname”NŒrefexplicit”ˆuh1hhhubh)”}”(hhh]”hŒJapanese”…””}”hhZsbah}”(h]”h ]”h"]”h$]”h&]”Œ	refdomain”h)Œreftype”h+Œ	reftarget”ŒA/translations/ja_JP/filesystems/nfs/nfsd-maintainer-entry-profile”Œmodname”NŒ	classname”NŒrefexplicit”ˆuh1hhhubh)”}”(hhh]”hŒKorean”…””}”hhnsbah}”(h]”h ]”h"]”h$]”h&]”Œ	refdomain”h)Œreftype”h+Œ	reftarget”ŒA/translations/ko_KR/filesystems/nfs/nfsd-maintainer-entry-profile”Œmodname”NŒ	classname”NŒrefexplicit”ˆuh1hhhubh)”}”(hhh]”hŒSpanish”…””}”hh‚sbah}”(h]”h ]”h"]”h$]”h&]”Œ	refdomain”h)Œreftype”h+Œ	reftarget”ŒA/translations/sp_SP/filesystems/nfs/nfsd-maintainer-entry-profile”Œmodname”NŒ	classname”NŒrefexplicit”ˆuh1hhhubeh}”(h]”h ]”h"]”h$]”h&]”Œcurrent_language”ŒEnglish”uh1h
hhŒ	_document”hŒsource”NŒline”NubhŒsection”“”)”}”(hhh]”(hŒtitle”“”)”}”(hŒNFSD Maintainer Entry Profile”h]”hŒNFSD Maintainer Entry Profile”…””}”(hh¨hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1h¦hh£hžhhŸŒ[/var/lib/git/docbuild/linux/Documentation/filesystems/nfs/nfsd-maintainer-entry-profile.rst”h KubhŒ	paragraph”“”)”}”(hXz  A Maintainer Entry Profile supplements the top-level process
documents (found in Documentation/process/) with customs that are
specific to a subsystem and its maintainers. A contributor may use
this document to set their expectations and avoid common mistakes.
A maintainer may use these profiles to look across subsystems for
opportunities to converge on best common practices.”h]”hXz  A Maintainer Entry Profile supplements the top-level process
documents (found in Documentation/process/) with customs that are
specific to a subsystem and its maintainers. A contributor may use
this document to set their expectations and avoid common mistakes.
A maintainer may use these profiles to look across subsystems for
opportunities to converge on best common practices.”…””}”(hh¹hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1h·hŸh¶h Khh£hžhubh¢)”}”(hhh]”(h§)”}”(hŒOverview”h]”hŒOverview”…””}”(hhÊhžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1h¦hhÇhžhhŸh¶h Kubh¸)”}”(hXB  The Network File System (NFS) is a standardized family of network
protocols that enable access to files across a set of network-
connected peer hosts. Applications on NFS clients access files that
reside on file systems that are shared by NFS servers. A single
network peer can act as both an NFS client and an NFS server.”h]”hXB  The Network File System (NFS) is a standardized family of network
protocols that enable access to files across a set of network-
connected peer hosts. Applications on NFS clients access files that
reside on file systems that are shared by NFS servers. A single
network peer can act as both an NFS client and an NFS server.”…””}”(hhØhžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1h·hŸh¶h KhhÇhžhubh¸)”}”(hX  NFSD refers to the NFS server implementation included in the Linux
kernel. An in-kernel NFS server has fast access to files stored
in file systems local to that server. NFSD can share files stored
on most of the file system types native to Linux, including xfs,
ext4, btrfs, and tmpfs.”h]”hX  NFSD refers to the NFS server implementation included in the Linux
kernel. An in-kernel NFS server has fast access to files stored
in file systems local to that server. NFSD can share files stored
on most of the file system types native to Linux, including xfs,
ext4, btrfs, and tmpfs.”…””}”(hhæhžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1h·hŸh¶h KhhÇhžhubeh}”(h]”Œoverview”ah ]”h"]”Œoverview”ah$]”h&]”uh1h¡hh£hžhhŸh¶h Kubh¢)”}”(hhh]”(h§)”}”(hŒMailing list”h]”hŒMailing list”…””}”(hhÿhžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1h¦hhühžhhŸh¶h Kubh¸)”}”(hX  The linux-nfs@vger.kernel.org mailing list is a public list. Its
purpose is to enable collaboration among developers working on the
Linux NFS stack, both client and server. It is not a place for
conversations that are not related directly to the Linux NFS stack.”h]”(hŒThe ”…””}”(hj  hžhhŸNh NubhŒ	reference”“”)”}”(hŒlinux-nfs@vger.kernel.org”h]”hŒlinux-nfs@vger.kernel.org”…””}”(hj  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”Œrefuri”Œ mailto:linux-nfs@vger.kernel.org”uh1j  hj  ubhŒé mailing list is a public list. Its
purpose is to enable collaboration among developers working on the
Linux NFS stack, both client and server. It is not a place for
conversations that are not related directly to the Linux NFS stack.”…””}”(hj  hžhhŸNh Nubeh}”(h]”h ]”h"]”h$]”h&]”uh1h·hŸh¶h Khhühžhubh¸)”}”(hŒbThe linux-nfs mailing list is archived on `lore.kernel.org <https://lore.kernel.org/linux-nfs/>`_.”h]”(hŒ*The linux-nfs mailing list is archived on ”…””}”(hj1  hžhhŸNh Nubj  )”}”(hŒ7`lore.kernel.org <https://lore.kernel.org/linux-nfs/>`_”h]”hŒlore.kernel.org”…””}”(hj9  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”Œname”Œlore.kernel.org”Œrefuri”Œ"https://lore.kernel.org/linux-nfs/”uh1j  hj1  ubhŒtarget”“”)”}”(hŒ% <https://lore.kernel.org/linux-nfs/>”h]”h}”(h]”Œlore-kernel-org”ah ]”h"]”Œlore.kernel.org”ah$]”h&]”Œrefuri”jJ  uh1jK  Œ
referenced”Khj1  ubhŒ.”…””}”(hj1  hžhhŸNh Nubeh}”(h]”h ]”h"]”h$]”h&]”uh1h·hŸh¶h K hhühžhubh¸)”}”(hŒ4The Linux NFS community does not have any chat room.”h]”hŒ4The Linux NFS community does not have any chat room.”…””}”(hje  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1h·hŸh¶h K"hhühžhubeh}”(h]”Œmailing-list”ah ]”h"]”Œmailing list”ah$]”h&]”uh1h¡hh£hžhhŸh¶h Kubh¢)”}”(hhh]”(h§)”}”(hŒReporting bugs”h]”hŒReporting bugs”…””}”(hj~  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1h¦hj{  hžhhŸh¶h K%ubh¸)”}”(hŒzIf you experience an NFSD-related bug on a distribution-built
kernel, please start by working with your Linux distributor.”h]”hŒzIf you experience an NFSD-related bug on a distribution-built
kernel, please start by working with your Linux distributor.”…””}”(hjŒ  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1h·hŸh¶h K&hj{  hžhubh¸)”}”(hŒÚBug reports against upstream Linux code bases are welcome on the
linux-nfs@vger.kernel.org mailing list, where some active triage
can be done. NFSD bugs may also be reported in the Linux kernel
community's bugzilla at:”h]”(hŒABug reports against upstream Linux code bases are welcome on the
”…””}”(hjš  hžhhŸNh Nubj  )”}”(hŒlinux-nfs@vger.kernel.org”h]”hŒlinux-nfs@vger.kernel.org”…””}”(hj¢  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”Œrefuri”Œ mailto:linux-nfs@vger.kernel.org”uh1j  hjš  ubhŒ‚ mailing list, where some active triage
can be done. NFSD bugs may also be reported in the Linux kernel
communityâ€™s bugzilla at:”…””}”(hjš  hžhhŸNh Nubeh}”(h]”h ]”h"]”h$]”h&]”uh1h·hŸh¶h K)hj{  hžhubhŒblock_quote”“”)”}”(hŒhttps://bugzilla.kernel.org
”h]”h¸)”}”(hŒhttps://bugzilla.kernel.org”h]”j  )”}”(hjÄ  h]”hŒhttps://bugzilla.kernel.org”…””}”(hjÆ  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”Œrefuri”jÄ  uh1j  hjÂ  ubah}”(h]”h ]”h"]”h$]”h&]”uh1h·hŸh¶h K.hj¾  ubah}”(h]”h ]”h"]”h$]”h&]”uh1j¼  hŸh¶h K.hj{  hžhubh¸)”}”(hŒÐPlease file NFSD-related bugs under the "Filesystems/NFSD"
component. In general, including as much detail as possible is a
good start, including pertinent system log messages from both
the client and server.”h]”hŒÔPlease file NFSD-related bugs under the â€œFilesystems/NFSDâ€
component. In general, including as much detail as possible is a
good start, including pertinent system log messages from both
the client and server.”…””}”(hjà  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1h·hŸh¶h K0hj{  hžhubh¸)”}”(hŒûUser space software related to NFSD, such as mountd or the exportfs
command, is contained in the nfs-utils package. Report problems
with those components to linux-nfs@vger.kernel.org. You might be
directed to move the report to a specific bug tracker.”h]”(hŒUser space software related to NFSD, such as mountd or the exportfs
command, is contained in the nfs-utils package. Report problems
with those components to ”…””}”(hjî  hžhhŸNh Nubj  )”}”(hŒlinux-nfs@vger.kernel.org”h]”hŒlinux-nfs@vger.kernel.org”…””}”(hjö  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”Œrefuri”Œ mailto:linux-nfs@vger.kernel.org”uh1j  hjî  ubhŒE. You might be
directed to move the report to a specific bug tracker.”…””}”(hjî  hžhhŸNh Nubeh}”(h]”h ]”h"]”h$]”h&]”uh1h·hŸh¶h K5hj{  hžhubeh}”(h]”Œreporting-bugs”ah ]”h"]”Œreporting bugs”ah$]”h&]”uh1h¡hh£hžhhŸh¶h K%ubh¢)”}”(hhh]”(h§)”}”(hŒContributor's Guide”h]”hŒContributorâ€™s Guide”…””}”(hj  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1h¦hj  hžhhŸh¶h K;ubh¢)”}”(hhh]”(h§)”}”(hŒStandards compliance”h]”hŒStandards compliance”…””}”(hj,  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1h¦hj)  hžhhŸh¶h K>ubh¸)”}”(hX  The priority is for NFSD to interoperate fully with the Linux NFS
client. We also test against other popular NFS client implementa-
tions regularly at NFS bake-a-thon events (also known as plug-
fests). Non-Linux NFS clients are not part of upstream NFSD CI/CD.”h]”hX  The priority is for NFSD to interoperate fully with the Linux NFS
client. We also test against other popular NFS client implementa-
tions regularly at NFS bake-a-thon events (also known as plug-
fests). Non-Linux NFS clients are not part of upstream NFSD CI/CD.”…””}”(hj:  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1h·hŸh¶h K?hj)  hžhubh¸)”}”(hX  The NFSD community strives to provide an NFS server implementation
that interoperates with all standards-compliant NFS client
implementations. This is done by staying as close as is sensible to
the normative mandates in the IETF's published NFS, RPC, and GSS-API
standards.”h]”hX  The NFSD community strives to provide an NFS server implementation
that interoperates with all standards-compliant NFS client
implementations. This is done by staying as close as is sensible to
the normative mandates in the IETFâ€™s published NFS, RPC, and GSS-API
standards.”…””}”(hjH  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1h·hŸh¶h KDhj)  hžhubh¸)”}”(hŒÇIt is always useful to reference an RFC and section number in a code
comment where behavior deviates from the standard (and even when the
behavior is compliant but the implementation is obfuscatory).”h]”hŒÇIt is always useful to reference an RFC and section number in a code
comment where behavior deviates from the standard (and even when the
behavior is compliant but the implementation is obfuscatory).”…””}”(hjV  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1h·hŸh¶h KJhj)  hžhubh¸)”}”(hŒÁOn the rare occasion when a deviation from standard-mandated
behavior is needed, brief documentation of the use case or
deficiencies in the standard is a required part of in-code
documentation.”h]”hŒÁOn the rare occasion when a deviation from standard-mandated
behavior is needed, brief documentation of the use case or
deficiencies in the standard is a required part of in-code
documentation.”…””}”(hjd  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1h·hŸh¶h KNhj)  hžhubh¸)”}”(hŒ¢Care must always be taken to avoid leaking local error codes (ie,
errnos) to clients of NFSD. A proper NFS status code is always
required in NFS protocol replies.”h]”hŒ¢Care must always be taken to avoid leaking local error codes (ie,
errnos) to clients of NFSD. A proper NFS status code is always
required in NFS protocol replies.”…””}”(hjr  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1h·hŸh¶h KShj)  hžhubeh}”(h]”Œstandards-compliance”ah ]”h"]”Œstandards compliance”ah$]”h&]”uh1h¡hj  hžhhŸh¶h K>ubh¢)”}”(hhh]”(h§)”}”(hŒNFSD administrative interfaces”h]”hŒNFSD administrative interfaces”…””}”(hj‹  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1h¦hjˆ  hžhhŸh¶h KXubh¸)”}”(hŒ'NFSD administrative interfaces include:”h]”hŒ'NFSD administrative interfaces include:”…””}”(hj™  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1h·hŸh¶h KYhjˆ  hžhubhŒbullet_list”“”)”}”(hhh]”(hŒ	list_item”“”)”}”(hŒ#an NFSD or SUNRPC module parameter
”h]”h¸)”}”(hŒ"an NFSD or SUNRPC module parameter”h]”hŒ"an NFSD or SUNRPC module parameter”…””}”(hj²  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1h·hŸh¶h K[hj®  ubah}”(h]”h ]”h"]”h$]”h&]”uh1j¬  hj©  hžhhŸh¶h Nubj­  )”}”(hŒexport options in /etc/exports
”h]”h¸)”}”(hŒexport options in /etc/exports”h]”hŒexport options in /etc/exports”…””}”(hjÊ  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1h·hŸh¶h K]hjÆ  ubah}”(h]”h ]”h"]”h$]”h&]”uh1j¬  hj©  hžhhŸh¶h Nubj­  )”}”(hŒ0files under /proc/fs/nfsd/ or /proc/sys/sunrpc/
”h]”h¸)”}”(hŒ/files under /proc/fs/nfsd/ or /proc/sys/sunrpc/”h]”hŒ/files under /proc/fs/nfsd/ or /proc/sys/sunrpc/”…””}”(hjâ  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1h·hŸh¶h K_hjÞ  ubah}”(h]”h ]”h"]”h$]”h&]”uh1j¬  hj©  hžhhŸh¶h Nubj­  )”}”(hŒthe NFSD netlink protocol
”h]”h¸)”}”(hŒthe NFSD netlink protocol”h]”hŒthe NFSD netlink protocol”…””}”(hjú  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1h·hŸh¶h Kahjö  ubah}”(h]”h ]”h"]”h$]”h&]”uh1j¬  hj©  hžhhŸh¶h Nubeh}”(h]”h ]”h"]”h$]”h&]”Œbullet”Œ-”uh1j§  hŸh¶h K[hjˆ  hžhubh¸)”}”(hX  Frequently, a request is made to introduce or modify one of NFSD's
traditional administrative interfaces. Certainly it is technically
easy to introduce a new administrative setting. However, there are
good reasons why the NFSD maintainers prefer to leave that as a last
resort:”h]”hX  Frequently, a request is made to introduce or modify one of NFSDâ€™s
traditional administrative interfaces. Certainly it is technically
easy to introduce a new administrative setting. However, there are
good reasons why the NFSD maintainers prefer to leave that as a last
resort:”…””}”(hj  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1h·hŸh¶h Kchjˆ  hžhubj¨  )”}”(hhh]”(j­  )”}”(hŒGAs with any API, administrative interfaces are difficult to get
right.
”h]”h¸)”}”(hŒFAs with any API, administrative interfaces are difficult to get
right.”h]”hŒFAs with any API, administrative interfaces are difficult to get
right.”…””}”(hj+  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1h·hŸh¶h Kihj'  ubah}”(h]”h ]”h"]”h$]”h&]”uh1j¬  hj$  hžhhŸh¶h Nubj­  )”}”(hŒsOnce they are documented and have a legacy of use, administrative
interfaces become difficult to modify or remove.
”h]”h¸)”}”(hŒrOnce they are documented and have a legacy of use, administrative
interfaces become difficult to modify or remove.”h]”hŒrOnce they are documented and have a legacy of use, administrative
interfaces become difficult to modify or remove.”…””}”(hjC  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1h·hŸh¶h Klhj?  ubah}”(h]”h ]”h"]”h$]”h&]”uh1j¬  hj$  hžhhŸh¶h Nubj­  )”}”(hŒBEvery new administrative setting multiplies the NFSD test matrix.
”h]”h¸)”}”(hŒAEvery new administrative setting multiplies the NFSD test matrix.”h]”hŒAEvery new administrative setting multiplies the NFSD test matrix.”…””}”(hj[  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1h·hŸh¶h KohjW  ubah}”(h]”h ]”h"]”h$]”h&]”uh1j¬  hj$  hžhhŸh¶h Nubj­  )”}”(hŒqThe cost of one administrative interface is incremental, but costs
add up across all of the existing interfaces.
”h]”h¸)”}”(hŒpThe cost of one administrative interface is incremental, but costs
add up across all of the existing interfaces.”h]”hŒpThe cost of one administrative interface is incremental, but costs
add up across all of the existing interfaces.”…””}”(hjs  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1h·hŸh¶h Kqhjo  ubah}”(h]”h ]”h"]”h$]”h&]”uh1j¬  hj$  hžhhŸh¶h Nubeh}”(h]”h ]”h"]”h$]”h&]”j  j  uh1j§  hŸh¶h Kihjˆ  hžhubh¸)”}”(hŒÇIt is often better for everyone if effort is made up front to
understanding the underlying requirement of the new setting, and
then trying to make it tune itself (or to become otherwise
unnecessary).”h]”hŒÇIt is often better for everyone if effort is made up front to
understanding the underlying requirement of the new setting, and
then trying to make it tune itself (or to become otherwise
unnecessary).”…””}”(hj  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1h·hŸh¶h Kthjˆ  hžhubh¸)”}”(hX  If a new setting is indeed necessary, first consider adding it to
the NFSD netlink protocol. Or if it doesn't need to be a reliable
long term user space feature, it can be added to NFSD's menagerie of
experimental settings which reside under /sys/kernel/debug/nfsd/ .”h]”hX  If a new setting is indeed necessary, first consider adding it to
the NFSD netlink protocol. Or if it doesnâ€™t need to be a reliable
long term user space feature, it can be added to NFSDâ€™s menagerie of
experimental settings which reside under /sys/kernel/debug/nfsd/ .”…””}”(hj›  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1h·hŸh¶h Kyhjˆ  hžhubeh}”(h]”Œnfsd-administrative-interfaces”ah ]”h"]”Œnfsd administrative interfaces”ah$]”h&]”uh1h¡hj  hžhhŸh¶h KXubh¢)”}”(hhh]”(h§)”}”(hŒField observability”h]”hŒField observability”…””}”(hj´  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1h¦hj±  hžhhŸh¶h Kubh¸)”}”(hŒñNFSD employs several different mechanisms for observing operation,
including counters, printks, WARNings, and static trace points. Each
have their strengths and weaknesses. Contributors should select the
most appropriate tool for their task.”h]”hŒñNFSD employs several different mechanisms for observing operation,
including counters, printks, WARNings, and static trace points. Each
have their strengths and weaknesses. Contributors should select the
most appropriate tool for their task.”…””}”(hjÂ  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1h·hŸh¶h K€hj±  hžhubj¨  )”}”(hhh]”(j­  )”}”(hŒ]BUG must be avoided if at all possible, as it will frequently
result in a full system crash.
”h]”h¸)”}”(hŒ\BUG must be avoided if at all possible, as it will frequently
result in a full system crash.”h]”hŒ\BUG must be avoided if at all possible, as it will frequently
result in a full system crash.”…””}”(hj×  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1h·hŸh¶h K…hjÓ  ubah}”(h]”h ]”h"]”h$]”h&]”uh1j¬  hjÐ  hžhhŸh¶h Nubj­  )”}”(hŒ<WARN is appropriate only when a full stack trace is useful.
”h]”h¸)”}”(hŒ;WARN is appropriate only when a full stack trace is useful.”h]”hŒ;WARN is appropriate only when a full stack trace is useful.”…””}”(hjï  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1h·hŸh¶h Kˆhjë  ubah}”(h]”h ]”h"]”h$]”h&]”uh1j¬  hjÐ  hžhhŸh¶h Nubj­  )”}”(hŒƒprintk can show detailed information. These must not be used
in code paths where they can be triggered repeatedly by remote
users.
”h]”h¸)”}”(hŒ‚printk can show detailed information. These must not be used
in code paths where they can be triggered repeatedly by remote
users.”h]”hŒ‚printk can show detailed information. These must not be used
in code paths where they can be triggered repeatedly by remote
users.”…””}”(hj  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1h·hŸh¶h KŠhj  ubah}”(h]”h ]”h"]”h$]”h&]”uh1j¬  hjÐ  hžhhŸh¶h Nubj­  )”}”(hŒ°dprintk can show detailed information, but can be enabled only
in pre-set groups. The overhead of emitting output makes dprintk
inappropriate for frequent operations like I/O.
”h]”h¸)”}”(hŒ¯dprintk can show detailed information, but can be enabled only
in pre-set groups. The overhead of emitting output makes dprintk
inappropriate for frequent operations like I/O.”h]”hŒ¯dprintk can show detailed information, but can be enabled only
in pre-set groups. The overhead of emitting output makes dprintk
inappropriate for frequent operations like I/O.”…””}”(hj  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1h·hŸh¶h KŽhj  ubah}”(h]”h ]”h"]”h$]”h&]”uh1j¬  hjÐ  hžhhŸh¶h Nubj­  )”}”(hŒuCounters are always on, but provide little information about
individual events other than how frequently they occur.
”h]”h¸)”}”(hŒtCounters are always on, but provide little information about
individual events other than how frequently they occur.”h]”hŒtCounters are always on, but provide little information about
individual events other than how frequently they occur.”…””}”(hj7  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1h·hŸh¶h K’hj3  ubah}”(h]”h ]”h"]”h$]”h&]”uh1j¬  hjÐ  hžhhŸh¶h Nubj­  )”}”(hŒ˜static trace points can be enabled individually or in groups
(via a glob). These are generally low overhead, and thus are
favored for use in hot paths.
”h]”h¸)”}”(hŒ—static trace points can be enabled individually or in groups
(via a glob). These are generally low overhead, and thus are
favored for use in hot paths.”h]”hŒ—static trace points can be enabled individually or in groups
(via a glob). These are generally low overhead, and thus are
favored for use in hot paths.”…””}”(hjO  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1h·hŸh¶h K•hjK  ubah}”(h]”h ]”h"]”h$]”h&]”uh1j¬  hjÐ  hžhhŸh¶h Nubj­  )”}”(hŒ†dynamic tracing, such as kprobes or eBPF, are quite flexible but
cannot be used in certain environments (eg, full kernel lock-
down).
”h]”h¸)”}”(hŒ…dynamic tracing, such as kprobes or eBPF, are quite flexible but
cannot be used in certain environments (eg, full kernel lock-
down).”h]”hŒ…dynamic tracing, such as kprobes or eBPF, are quite flexible but
cannot be used in certain environments (eg, full kernel lock-
down).”…””}”(hjg  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1h·hŸh¶h K™hjc  ubah}”(h]”h ]”h"]”h$]”h&]”uh1j¬  hjÐ  hžhhŸh¶h Nubeh}”(h]”h ]”h"]”h$]”h&]”j  j  uh1j§  hŸh¶h K…hj±  hžhubeh}”(h]”Œfield-observability”ah ]”h"]”Œfield observability”ah$]”h&]”uh1h¡hj  hžhhŸh¶h Kubh¢)”}”(hhh]”(h§)”}”(hŒTesting”h]”hŒTesting”…””}”(hjŒ  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1h¦hj‰  hžhhŸh¶h Kžubh¸)”}”(hŒThe kdevops project”h]”hŒThe kdevops project”…””}”(hjš  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1h·hŸh¶h KŸhj‰  hžhubj½  )”}”(hŒ)https://github.com/linux-kdevops/kdevops
”h]”h¸)”}”(hŒ(https://github.com/linux-kdevops/kdevops”h]”j  )”}”(hj®  h]”hŒ(https://github.com/linux-kdevops/kdevops”…””}”(hj°  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”Œrefuri”j®  uh1j  hj¬  ubah}”(h]”h ]”h"]”h$]”h&]”uh1h·hŸh¶h K¡hj¨  ubah}”(h]”h ]”h"]”h$]”h&]”uh1j¼  hŸh¶h K¡hj‰  hžhubh¸)”}”(hXJ  contains several NFS-specific workflows, as well as the community
standard fstests suite. These workflows are based on open source
testing tools such as ltp and fio. Contributors are encouraged to
use these tools without kdevops, or contributors should install and
use kdevops themselves to verify their patches before submission.”h]”hXJ  contains several NFS-specific workflows, as well as the community
standard fstests suite. These workflows are based on open source
testing tools such as ltp and fio. Contributors are encouraged to
use these tools without kdevops, or contributors should install and
use kdevops themselves to verify their patches before submission.”…””}”(hjÊ  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1h·hŸh¶h K£hj‰  hžhubeh}”(h]”Œtesting”ah ]”h"]”Œtesting”ah$]”h&]”uh1h¡hj  hžhhŸh¶h Kžubh¢)”}”(hhh]”(h§)”}”(hŒCoding style”h]”hŒCoding style”…””}”(hjã  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1h¦hjà  hžhhŸh¶h Kªubh¸)”}”(hŒ0Follow the coding style preferences described in”h]”hŒ0Follow the coding style preferences described in”…””}”(hjñ  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1h·hŸh¶h K«hjà  hžhubj½  )”}”(hŒ'Documentation/process/coding-style.rst
”h]”h¸)”}”(hŒ&Documentation/process/coding-style.rst”h]”hŒ&Documentation/process/coding-style.rst”…””}”(hj  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1h·hŸh¶h K­hjÿ  ubah}”(h]”h ]”h"]”h$]”h&]”uh1j¼  hŸh¶h K­hjà  hžhubh¸)”}”(hŒwith the following exceptions:”h]”hŒwith the following exceptions:”…””}”(hj  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1h·hŸh¶h K¯hjà  hžhubj¨  )”}”(hhh]”(j­  )”}”(hŒFAdd new local variables to a function in reverse Christmas tree
order
”h]”h¸)”}”(hŒEAdd new local variables to a function in reverse Christmas tree
order”h]”hŒEAdd new local variables to a function in reverse Christmas tree
order”…””}”(hj,  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1h·hŸh¶h K±hj(  ubah}”(h]”h ]”h"]”h$]”h&]”uh1j¬  hj%  hžhhŸh¶h Nubj­  )”}”(hŒˆUse the kdoc comment style for
+ non-static functions
+ static inline functions
+ static functions that are callbacks/virtual functions
”h]”h¸)”}”(hŒ‡Use the kdoc comment style for
+ non-static functions
+ static inline functions
+ static functions that are callbacks/virtual functions”h]”hŒ‡Use the kdoc comment style for
+ non-static functions
+ static inline functions
+ static functions that are callbacks/virtual functions”…””}”(hjD  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1h·hŸh¶h K´hj@  ubah}”(h]”h ]”h"]”h$]”h&]”uh1j¬  hj%  hžhhŸh¶h Nubj­  )”}”(hŒUAll new function names start with ``nfsd_`` for non-NFS-version-
specific functions.
”h]”h¸)”}”(hŒTAll new function names start with ``nfsd_`` for non-NFS-version-
specific functions.”h]”(hŒ"All new function names start with ”…””}”(hj\  hžhhŸNh NubhŒliteral”“”)”}”(hŒ	``nfsd_``”h]”hŒnfsd_”…””}”(hjf  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1jd  hj\  ubhŒ) for non-NFS-version-
specific functions.”…””}”(hj\  hžhhŸNh Nubeh}”(h]”h ]”h"]”h$]”h&]”uh1h·hŸh¶h K¹hjX  ubah}”(h]”h ]”h"]”h$]”h&]”uh1j¬  hj%  hžhhŸh¶h Nubj­  )”}”(hŒ‹New function names that are specific to NFSv2 or NFSv3, or are
used by all minor versions of NFSv4, use ``nfsdN_`` where N is
the version.
”h]”h¸)”}”(hŒŠNew function names that are specific to NFSv2 or NFSv3, or are
used by all minor versions of NFSv4, use ``nfsdN_`` where N is
the version.”h]”(hŒhNew function names that are specific to NFSv2 or NFSv3, or are
used by all minor versions of NFSv4, use ”…””}”(hjˆ  hžhhŸNh Nubje  )”}”(hŒ
``nfsdN_``”h]”hŒnfsdN_”…””}”(hj  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1jd  hjˆ  ubhŒ where N is
the version.”…””}”(hjˆ  hžhhŸNh Nubeh}”(h]”h ]”h"]”h$]”h&]”uh1h·hŸh¶h K¼hj„  ubah}”(h]”h ]”h"]”h$]”h&]”uh1j¬  hj%  hžhhŸh¶h Nubj­  )”}”(hŒrNew function names specific to an NFSv4 minor version can be
named with ``nfsd4M_`` where M is the minor version.
”h]”h¸)”}”(hŒqNew function names specific to an NFSv4 minor version can be
named with ``nfsd4M_`` where M is the minor version.”h]”(hŒHNew function names specific to an NFSv4 minor version can be
named with ”…””}”(hj²  hžhhŸNh Nubje  )”}”(hŒ``nfsd4M_``”h]”hŒnfsd4M_”…””}”(hjº  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1jd  hj²  ubhŒ where M is the minor version.”…””}”(hj²  hžhhŸNh Nubeh}”(h]”h ]”h"]”h$]”h&]”uh1h·hŸh¶h KÀhj®  ubah}”(h]”h ]”h"]”h$]”h&]”uh1j¬  hj%  hžhhŸh¶h Nubeh}”(h]”h ]”h"]”h$]”h&]”j  j  uh1j§  hŸh¶h K±hjà  hžhubeh}”(h]”Œcoding-style”ah ]”h"]”Œcoding style”ah$]”h&]”uh1h¡hj  hžhhŸh¶h Kªubh¢)”}”(hhh]”(h§)”}”(hŒPatch preparation”h]”hŒPatch preparation”…””}”(hjé  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1h¦hjæ  hžhhŸh¶h KÄubh¸)”}”(hŒ!Read and follow all guidelines in”h]”hŒ!Read and follow all guidelines in”…””}”(hj÷  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1h·hŸh¶h KÅhjæ  hžhubj½  )”}”(hŒ-Documentation/process/submitting-patches.rst
”h]”h¸)”}”(hŒ,Documentation/process/submitting-patches.rst”h]”hŒ,Documentation/process/submitting-patches.rst”…””}”(hj	  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1h·hŸh¶h KÇhj  ubah}”(h]”h ]”h"]”h$]”h&]”uh1j¼  hŸh¶h KÇhjæ  hžhubh¸)”}”(hX+  Use tagging to identify all patch authors. However, reviewers and
testers should be added by replying to the email patch submission.
Email is extensively used in order to publicly archive review and
testing attributions. These tags are automatically inserted into
your patches when they are applied.”h]”hX+  Use tagging to identify all patch authors. However, reviewers and
testers should be added by replying to the email patch submission.
Email is extensively used in order to publicly archive review and
testing attributions. These tags are automatically inserted into
your patches when they are applied.”…””}”(hj  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1h·hŸh¶h KÉhjæ  hžhubh¸)”}”(hŒÁThe code in the body of the diff already shows /what/ is being
changed. Thus it is not necessary to repeat that in the patch
description. Instead, the description should contain one or more
of:”h]”hŒÁThe code in the body of the diff already shows /what/ is being
changed. Thus it is not necessary to repeat that in the patch
description. Instead, the description should contain one or more
of:”…””}”(hj+  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1h·hŸh¶h KÏhjæ  hžhubj¨  )”}”(hhh]”(j­  )”}”(hŒ\A brief problem statement ("what is this patch trying to fix?")
with a root-cause analysis.
”h]”h¸)”}”(hŒ[A brief problem statement ("what is this patch trying to fix?")
with a root-cause analysis.”h]”hŒ_A brief problem statement (â€œwhat is this patch trying to fix?â€)
with a root-cause analysis.”…””}”(hj@  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1h·hŸh¶h KÔhj<  ubah}”(h]”h ]”h"]”h$]”h&]”uh1j¬  hj9  hžhhŸh¶h Nubj­  )”}”(hŒqEnd-user visible symptoms or items that a support engineer might
use to search for the patch, like stack traces.
”h]”h¸)”}”(hŒpEnd-user visible symptoms or items that a support engineer might
use to search for the patch, like stack traces.”h]”hŒpEnd-user visible symptoms or items that a support engineer might
use to search for the patch, like stack traces.”…””}”(hjX  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1h·hŸh¶h K×hjT  ubah}”(h]”h ]”h"]”h$]”h&]”uh1j¬  hj9  hžhhŸh¶h Nubj­  )”}”(hŒMA brief explanation of why the patch is the best way to address
the problem.
”h]”h¸)”}”(hŒLA brief explanation of why the patch is the best way to address
the problem.”h]”hŒLA brief explanation of why the patch is the best way to address
the problem.”…””}”(hjp  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1h·hŸh¶h KÚhjl  ubah}”(h]”h ]”h"]”h$]”h&]”uh1j¬  hj9  hžhhŸh¶h Nubj­  )”}”(hŒSAny context that reviewers might need to understand the changes
made by the patch.
”h]”h¸)”}”(hŒRAny context that reviewers might need to understand the changes
made by the patch.”h]”hŒRAny context that reviewers might need to understand the changes
made by the patch.”…””}”(hjˆ  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1h·hŸh¶h KÝhj„  ubah}”(h]”h ]”h"]”h$]”h&]”uh1j¬  hj9  hžhhŸh¶h Nubj­  )”}”(hŒCAny relevant benchmarking results, and/or functional test results.
”h]”h¸)”}”(hŒBAny relevant benchmarking results, and/or functional test results.”h]”hŒBAny relevant benchmarking results, and/or functional test results.”…””}”(hj   hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1h·hŸh¶h Kàhjœ  ubah}”(h]”h ]”h"]”h$]”h&]”uh1j¬  hj9  hžhhŸh¶h Nubeh}”(h]”h ]”h"]”h$]”h&]”j  j  uh1j§  hŸh¶h KÔhjæ  hžhubh¸)”}”(hŒŸAs detailed in Documentation/process/submitting-patches.rst,
identify the point in history that the issue being addressed was
introduced by using a Fixes: tag.”h]”hŒŸAs detailed in Documentation/process/submitting-patches.rst,
identify the point in history that the issue being addressed was
introduced by using a Fixes: tag.”…””}”(hjº  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1h·hŸh¶h Kâhjæ  hžhubh¸)”}”(hŒñMention in the patch description if that point in history cannot be
determined -- that is, no Fixes: tag can be provided. In this case,
please make it clear to maintainers whether an LTS backport is
needed even though there is no Fixes: tag.”h]”hŒñMention in the patch description if that point in history cannot be
determined -- that is, no Fixes: tag can be provided. In this case,
please make it clear to maintainers whether an LTS backport is
needed even though there is no Fixes: tag.”…””}”(hjÈ  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1h·hŸh¶h Kæhjæ  hžhubh¸)”}”(hX  The NFSD maintainers prefer to add stable tagging themselves, after
public discussion in response to the patch submission. Contributors
may suggest stable tagging, but be aware that many version
management tools add such stable Cc's when you post your patches.
Don't add "Cc: stable" unless you are absolutely sure the patch
needs to go to stable during the initial submission process.”h]”hX‰  The NFSD maintainers prefer to add stable tagging themselves, after
public discussion in response to the patch submission. Contributors
may suggest stable tagging, but be aware that many version
management tools add such stable Ccâ€™s when you post your patches.
Donâ€™t add â€œCc: stableâ€ unless you are absolutely sure the patch
needs to go to stable during the initial submission process.”…””}”(hjÖ  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1h·hŸh¶h Këhjæ  hžhubeh}”(h]”Œpatch-preparation”ah ]”h"]”Œpatch preparation”ah$]”h&]”uh1h¡hj  hžhhŸh¶h KÄubh¢)”}”(hhh]”(h§)”}”(hŒPatch submission”h]”hŒPatch submission”…””}”(hjï  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1h¦hjì  hžhhŸh¶h Kóubh¸)”}”(hŒyPatches to NFSD are submitted via the kernel's email-based review
process that is common to most other kernel subsystems.”h]”hŒ{Patches to NFSD are submitted via the kernelâ€™s email-based review
process that is common to most other kernel subsystems.”…””}”(hjý  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1h·hŸh¶h Kôhjì  hžhubh¸)”}”(hŒVJust before each submission, rebase your patch or series on the
nfsd-testing branch at”h]”hŒVJust before each submission, rebase your patch or series on the
nfsd-testing branch at”…””}”(hj  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1h·hŸh¶h K÷hjì  hžhubj½  )”}”(hŒ>https://git.kernel.org/pub/scm/linux/kernel/git/cel/linux.git
”h]”h¸)”}”(hŒ=https://git.kernel.org/pub/scm/linux/kernel/git/cel/linux.git”h]”j  )”}”(hj  h]”hŒ=https://git.kernel.org/pub/scm/linux/kernel/git/cel/linux.git”…””}”(hj!  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”Œrefuri”j  uh1j  hj  ubah}”(h]”h ]”h"]”h$]”h&]”uh1h·hŸh¶h Kúhj  ubah}”(h]”h ]”h"]”h$]”h&]”uh1j¼  hŸh¶h Kúhjì  hžhubh¸)”}”(hŒ÷The NFSD subsystem is maintained separately from the Linux in-kernel
NFS client. The NFSD maintainers do not normally take submissions
for client changes, nor can they respond authoritatively to bug
reports or feature requests for NFS client code.”h]”hŒ÷The NFSD subsystem is maintained separately from the Linux in-kernel
NFS client. The NFSD maintainers do not normally take submissions
for client changes, nor can they respond authoritatively to bug
reports or feature requests for NFS client code.”…””}”(hj;  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1h·hŸh¶h Kühjì  hžhubh¸)”}”(hŒÓThis means that contributors might be asked to resubmit patches if
they were emailed to the incorrect set of maintainers and reviewers.
This is not a rejection, but simply a correction of the submission
process.”h]”hŒÓThis means that contributors might be asked to resubmit patches if
they were emailed to the incorrect set of maintainers and reviewers.
This is not a rejection, but simply a correction of the submission
process.”…””}”(hjI  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1h·hŸh¶h Mhjì  hžhubh¸)”}”(hŒWhen in doubt, consult the NFSD entry in the MAINTAINERS file to
see which files and directories fall under the NFSD subsystem.”h]”hŒWhen in doubt, consult the NFSD entry in the MAINTAINERS file to
see which files and directories fall under the NFSD subsystem.”…””}”(hjW  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1h·hŸh¶h Mhjì  hžhubh¸)”}”(hŒ7The proper set of email addresses for NFSD patches are:”h]”hŒ7The proper set of email addresses for NFSD patches are:”…””}”(hje  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1h·hŸh¶h M	hjì  hžhubh¸)”}”(hŒwTo: the NFSD maintainers and reviewers listed in MAINTAINERS
Cc: linux-nfs@vger.kernel.org and optionally linux-kernel@”h]”(hŒATo: the NFSD maintainers and reviewers listed in MAINTAINERS
Cc: ”…””}”(hjs  hžhhŸNh Nubj  )”}”(hŒlinux-nfs@vger.kernel.org”h]”hŒlinux-nfs@vger.kernel.org”…””}”(hj{  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”Œrefuri”Œ mailto:linux-nfs@vger.kernel.org”uh1j  hjs  ubhŒ and optionally linux-kernel@”…””}”(hjs  hžhhŸNh Nubeh}”(h]”h ]”h"]”h$]”h&]”uh1h·hŸh¶h Mhjì  hžhubh¸)”}”(hŒÜIf there are other subsystems involved in the patches (for example
MM or RDMA) their primary mailing list address can be included in
the Cc: field. Other contributors and interested parties may be
included there as well.”h]”hŒÜIf there are other subsystems involved in the patches (for example
MM or RDMA) their primary mailing list address can be included in
the Cc: field. Other contributors and interested parties may be
included there as well.”…””}”(hj•  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1h·hŸh¶h Mhjì  hžhubh¸)”}”(hŒ³In general we prefer that contributors use common patch email tools
such as "git send-email" or "stg email format/send", which tend to
get the details right without a lot of fuss.”h]”hŒ»In general we prefer that contributors use common patch email tools
such as â€œgit send-emailâ€ or â€œstg email format/sendâ€, which tend to
get the details right without a lot of fuss.”…””}”(hj£  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1h·hŸh¶h Mhjì  hžhubh¸)”}”(hŒÒA series consisting of a single patch is not required to have a
cover letter. However, a cover letter can be included if there is
substantial context that is not appropriate to include in the
patch description.”h]”hŒÒA series consisting of a single patch is not required to have a
cover letter. However, a cover letter can be included if there is
substantial context that is not appropriate to include in the
patch description.”…””}”(hj±  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1h·hŸh¶h Mhjì  hžhubh¸)”}”(hŒþPlease note that, with an e-mail based submission process, series
cover letters are not part of the work that is committed to the
kernel source code base or its commit history. Therefore always try
to keep pertinent information in the patch descriptions.”h]”hŒþPlease note that, with an e-mail based submission process, series
cover letters are not part of the work that is committed to the
kernel source code base or its commit history. Therefore always try
to keep pertinent information in the patch descriptions.”…””}”(hj¿  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1h·hŸh¶h Mhjì  hžhubh¸)”}”(hŒ¹Design documentation is welcome, but as cover letters are not
preserved, a perhaps better option is to include a patch that adds
such documentation under Documentation/filesystems/nfs/.”h]”hŒ¹Design documentation is welcome, but as cover letters are not
preserved, a perhaps better option is to include a patch that adds
such documentation under Documentation/filesystems/nfs/.”…””}”(hjÍ  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1h·hŸh¶h M!hjì  hžhubh¸)”}”(hŒŒReviewers will ask about test coverage and what use cases the
patches are expected to address. Please be prepared to answer these
questions.”h]”hŒŒReviewers will ask about test coverage and what use cases the
patches are expected to address. Please be prepared to answer these
questions.”…””}”(hjÛ  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1h·hŸh¶h M%hjì  hžhubh¸)”}”(hX  Review comments from maintainers might be politely stated, but in
general, these are not optional to address when they are actionable.
If necessary, the maintainers retain the right to not apply patches
when contributors refuse to address reasonable requests.”h]”hX  Review comments from maintainers might be politely stated, but in
general, these are not optional to address when they are actionable.
If necessary, the maintainers retain the right to not apply patches
when contributors refuse to address reasonable requests.”…””}”(hjé  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1h·hŸh¶h M)hjì  hžhubh¸)”}”(hŒ•Post changes to kernel source code and user space source code as
separate series. You can connect the two series with comments in
your cover letters.”h]”hŒ•Post changes to kernel source code and user space source code as
separate series. You can connect the two series with comments in
your cover letters.”…””}”(hj÷  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1h·hŸh¶h M.hjì  hžhubh¸)”}”(hX2  Generally the NFSD maintainers ask for a reposts even for simple
modifications in order to publicly archive the request and the
resulting repost before it is pulled into the NFSD trees. This
also enables us to rebuild a patch series quickly without missing
changes that might have been discussed via email.”h]”hX2  Generally the NFSD maintainers ask for a reposts even for simple
modifications in order to publicly archive the request and the
resulting repost before it is pulled into the NFSD trees. This
also enables us to rebuild a patch series quickly without missing
changes that might have been discussed via email.”…””}”(hj  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1h·hŸh¶h M2hjì  hžhubh¸)”}”(hŒ¨Avoid frequently reposting large series with only small changes. As
a rule of thumb, posting substantial changes more than once a week
will result in reviewer overload.”h]”hŒ¨Avoid frequently reposting large series with only small changes. As
a rule of thumb, posting substantial changes more than once a week
will result in reviewer overload.”…””}”(hj  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1h·hŸh¶h M8hjì  hžhubh¸)”}”(hŒüRemember, there are only a handful of subsystem maintainers and
reviewers, but potentially many sources of contributions. The
maintainers and reviewers, therefore, are always the less scalable
resource. Be kind to your friendly neighborhood maintainer.”h]”hŒüRemember, there are only a handful of subsystem maintainers and
reviewers, but potentially many sources of contributions. The
maintainers and reviewers, therefore, are always the less scalable
resource. Be kind to your friendly neighborhood maintainer.”…””}”(hj!  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1h·hŸh¶h M<hjì  hžhubeh}”(h]”Œpatch-submission”ah ]”h"]”Œpatch submission”ah$]”h&]”uh1h¡hj  hžhhŸh¶h Kóubh¢)”}”(hhh]”(h§)”}”(hŒPatch Acceptance”h]”hŒPatch Acceptance”…””}”(hj:  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1h¦hj7  hžhhŸh¶h MBubh¸)”}”(hŒðThere isn't a formal review process for NFSD, but we like to see
at least two Reviewed-by: notices for patches that are more than
simple clean-ups. Reviews are done in public on
linux-nfs@vger.kernel.org and are archived on lore.kernel.org.”h]”(hŒ´There isnâ€™t a formal review process for NFSD, but we like to see
at least two Reviewed-by: notices for patches that are more than
simple clean-ups. Reviews are done in public on
”…””}”(hjH  hžhhŸNh Nubj  )”}”(hŒlinux-nfs@vger.kernel.org”h]”hŒlinux-nfs@vger.kernel.org”…””}”(hjP  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”Œrefuri”Œ mailto:linux-nfs@vger.kernel.org”uh1j  hjH  ubhŒ% and are archived on lore.kernel.org.”…””}”(hjH  hžhhŸNh Nubeh}”(h]”h ]”h"]”h$]”h&]”uh1h·hŸh¶h MChj7  hžhubh¸)”}”(hŒ@Currently the NFSD patch queues are maintained in branches here:”h]”hŒ@Currently the NFSD patch queues are maintained in branches here:”…””}”(hjj  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1h·hŸh¶h MHhj7  hžhubj½  )”}”(hŒ>https://git.kernel.org/pub/scm/linux/kernel/git/cel/linux.git
”h]”h¸)”}”(hŒ=https://git.kernel.org/pub/scm/linux/kernel/git/cel/linux.git”h]”j  )”}”(hj~  h]”hŒ=https://git.kernel.org/pub/scm/linux/kernel/git/cel/linux.git”…””}”(hj€  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”Œrefuri”j~  uh1j  hj|  ubah}”(h]”h ]”h"]”h$]”h&]”uh1h·hŸh¶h MJhjx  ubah}”(h]”h ]”h"]”h$]”h&]”uh1j¼  hŸh¶h MJhj7  hžhubh¸)”}”(hX2  The NFSD maintainers apply patches initially to the nfsd-testing
branch, which is always open to new submissions. Patches can be
applied while review is ongoing. nfsd-testing is a topic branch,
so it can change frequently, it will be rebased, and your patch
might get dropped if there is a problem with it.”h]”hX2  The NFSD maintainers apply patches initially to the nfsd-testing
branch, which is always open to new submissions. Patches can be
applied while review is ongoing. nfsd-testing is a topic branch,
so it can change frequently, it will be rebased, and your patch
might get dropped if there is a problem with it.”…””}”(hjš  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1h·hŸh¶h MLhj7  hžhubh¸)”}”(hŒÉGenerally a script-generated "thank you" email will indicate when
your patch has been added to the nfsd-testing branch. You can track
the progress of your patch using the linux-nfs patchworks instance:”h]”hŒÍGenerally a script-generated â€œthank youâ€ email will indicate when
your patch has been added to the nfsd-testing branch. You can track
the progress of your patch using the linux-nfs patchworks instance:”…””}”(hj¨  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1h·hŸh¶h MRhj7  hžhubj½  )”}”(hŒ5https://patchwork.kernel.org/project/linux-nfs/list/
”h]”h¸)”}”(hŒ4https://patchwork.kernel.org/project/linux-nfs/list/”h]”j  )”}”(hj¼  h]”hŒ4https://patchwork.kernel.org/project/linux-nfs/list/”…””}”(hj¾  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”Œrefuri”j¼  uh1j  hjº  ubah}”(h]”h ]”h"]”h$]”h&]”uh1h·hŸh¶h MVhj¶  ubah}”(h]”h ]”h"]”h$]”h&]”uh1j¼  hŸh¶h MVhj7  hžhubh¸)”}”(hŒàWhile your patch is in nfsd-testing, it is exposed to a variety of
test environments, including community zero-day bots, static
analysis tools, and NFSD continuous integration testing. The soak
period is three to four weeks.”h]”hŒàWhile your patch is in nfsd-testing, it is exposed to a variety of
test environments, including community zero-day bots, static
analysis tools, and NFSD continuous integration testing. The soak
period is three to four weeks.”…””}”(hjØ  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1h·hŸh¶h MXhj7  hžhubh¸)”}”(hŒnEach patch that survives in nfsd-testing for the soak period without
changes is moved to the nfsd-next branch.”h]”hŒnEach patch that survives in nfsd-testing for the soak period without
changes is moved to the nfsd-next branch.”…””}”(hjæ  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1h·hŸh¶h M]hj7  hžhubh¸)”}”(hŒ\The nfsd-next branch is automatically merged into linux-next and
fs-next on a nightly basis.”h]”hŒ\The nfsd-next branch is automatically merged into linux-next and
fs-next on a nightly basis.”…””}”(hjô  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1h·hŸh¶h M`hj7  hžhubh¸)”}”(hŒ™Patches that survive in nfsd-next are included in the next NFSD
merge window pull request. These windows typically occur once every
63 days (nine weeks).”h]”hŒ™Patches that survive in nfsd-next are included in the next NFSD
merge window pull request. These windows typically occur once every
63 days (nine weeks).”…””}”(hj	  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1h·hŸh¶h Mchj7  hžhubh¸)”}”(hŒ™When the upstream merge window closes, the nfsd-next branch is
renamed nfsd-fixes, and a new nfsd-next branch is created, based on
the upstream -rc1 tag.”h]”hŒ™When the upstream merge window closes, the nfsd-next branch is
renamed nfsd-fixes, and a new nfsd-next branch is created, based on
the upstream -rc1 tag.”…””}”(hj	  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1h·hŸh¶h Mghj7  hžhubh¸)”}”(hXw  Fixes that are destined for an upstream -rc release also run the
nfsd-testing gauntlet, but are then applied to the nfsd-fixes
branch. That branch is made available for Linus to pull after a
short time. In order to limit the risk of introducing regressions,
we limit such fixes to emergency situations or fixes to breakage
that occurred during the most recent upstream merge.”h]”hXw  Fixes that are destined for an upstream -rc release also run the
nfsd-testing gauntlet, but are then applied to the nfsd-fixes
branch. That branch is made available for Linus to pull after a
short time. In order to limit the risk of introducing regressions,
we limit such fixes to emergency situations or fixes to breakage
that occurred during the most recent upstream merge.”…””}”(hj	  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1h·hŸh¶h Mkhj7  hžhubh¸)”}”(hŒ„Please make it clear when submitting an emergency patch that
immediate action (either application to -rc or LTS backport) is
needed.”h]”hŒ„Please make it clear when submitting an emergency patch that
immediate action (either application to -rc or LTS backport) is
needed.”…””}”(hj,	  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1h·hŸh¶h Mrhj7  hžhubeh}”(h]”Œpatch-acceptance”ah ]”h"]”Œpatch acceptance”ah$]”h&]”uh1h¡hj  hžhhŸh¶h MBubh¢)”}”(hhh]”(h§)”}”(hŒ+Sensitive patch submissions and bug reports”h]”hŒ+Sensitive patch submissions and bug reports”…””}”(hjE	  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1h¦hjB	  hžhhŸh¶h Mwubh¸)”}”(hŒÑCVEs are generated by specific members of the Linux kernel community
and several external entities. The Linux NFS community does not emit
or assign CVEs. CVEs are assigned after an issue and its fix are
known.”h]”hŒÑCVEs are generated by specific members of the Linux kernel community
and several external entities. The Linux NFS community does not emit
or assign CVEs. CVEs are assigned after an issue and its fix are
known.”…””}”(hjS	  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1h·hŸh¶h MxhjB	  hžhubh¸)”}”(hŒÝHowever, the NFSD maintainers sometimes receive sensitive security
reports, and at times these are significant enough to need to be
embargoed. In such rare cases, fixes can be developed and reviewed
out of the public eye.”h]”hŒÝHowever, the NFSD maintainers sometimes receive sensitive security
reports, and at times these are significant enough to need to be
embargoed. In such rare cases, fixes can be developed and reviewed
out of the public eye.”…””}”(hja	  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1h·hŸh¶h M}hjB	  hžhubh¸)”}”(hXD  Please be aware that many version management tools add the stable
Cc's when you post your patches. This is generally a nuisance, but
it can result in outing an embargoed security issue accidentally.
Don't add "Cc: stable" unless you are absolutely sure the patch
needs to go to stable@ during the initial submission process.”h]”hXL  Please be aware that many version management tools add the stable
Ccâ€™s when you post your patches. This is generally a nuisance, but
it can result in outing an embargoed security issue accidentally.
Donâ€™t add â€œCc: stableâ€ unless you are absolutely sure the patch
needs to go to stable@ during the initial submission process.”…””}”(hjo	  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1h·hŸh¶h M‚hjB	  hžhubh¸)”}”(hX?  Patches that are merged without ever appearing on any list, and
which carry a Reported-by: or Fixes: tag are detected as suspicious
by security-focused people. We encourage that, after any private
review, security-sensitive patches should be posted to linux-nfs@
for the usual public review, archiving, and test period.”h]”hX?  Patches that are merged without ever appearing on any list, and
which carry a Reported-by: or Fixes: tag are detected as suspicious
by security-focused people. We encourage that, after any private
review, security-sensitive patches should be posted to linux-nfs@
for the usual public review, archiving, and test period.”…””}”(hj}	  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1h·hŸh¶h MˆhjB	  hžhubeh}”(h]”Œ+sensitive-patch-submissions-and-bug-reports”ah ]”h"]”Œ+sensitive patch submissions and bug reports”ah$]”h&]”uh1h¡hj  hžhhŸh¶h Mwubh¢)”}”(hhh]”(h§)”}”(hŒLLM-generated submissions”h]”hŒLLM-generated submissions”…””}”(hj–	  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1h¦hj“	  hžhhŸh¶h Mubh¸)”}”(hX@  The Linux kernel community as a whole is still exploring the new
world of LLM-generated code. The NFSD maintainers will entertain
submission of patches that are partially or wholly generated by
LLM-based development tools. Such submissions are held to the
same standards as submissions created entirely by human authors:”h]”hX@  The Linux kernel community as a whole is still exploring the new
world of LLM-generated code. The NFSD maintainers will entertain
submission of patches that are partially or wholly generated by
LLM-based development tools. Such submissions are held to the
same standards as submissions created entirely by human authors:”…””}”(hj¤	  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1h·hŸh¶h Mhj“	  hžhubj¨  )”}”(hhh]”(j­  )”}”(hŒ`The human contributor identifies themselves via a Signed-off-by:
tag. This tag counts as a DoC.
”h]”h¸)”}”(hŒ_The human contributor identifies themselves via a Signed-off-by:
tag. This tag counts as a DoC.”h]”hŒ_The human contributor identifies themselves via a Signed-off-by:
tag. This tag counts as a DoC.”…””}”(hj¹	  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1h·hŸh¶h M–hjµ	  ubah}”(h]”h ]”h"]”h$]”h&]”uh1j¬  hj²	  hžhhŸh¶h Nubj­  )”}”(hŒ›The human contributor is solely responsible for code provenance
and any contamination by inadvertently-included code with a
conflicting license, as usual.
”h]”h¸)”}”(hŒšThe human contributor is solely responsible for code provenance
and any contamination by inadvertently-included code with a
conflicting license, as usual.”h]”hŒšThe human contributor is solely responsible for code provenance
and any contamination by inadvertently-included code with a
conflicting license, as usual.”…””}”(hjÑ	  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1h·hŸh¶h M™hjÍ	  ubah}”(h]”h ]”h"]”h$]”h&]”uh1j¬  hj²	  hžhhŸh¶h Nubj­  )”}”(hŒ§The human contributor must be able to answer and address review
questions. A patch description such as "This fixed my problem
but I don't know why" is not acceptable.
”h]”h¸)”}”(hŒ¦The human contributor must be able to answer and address review
questions. A patch description such as "This fixed my problem
but I don't know why" is not acceptable.”h]”hŒ¬The human contributor must be able to answer and address review
questions. A patch description such as â€œThis fixed my problem
but I donâ€™t know whyâ€ is not acceptable.”…””}”(hjé	  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1h·hŸh¶h Mhjå	  ubah}”(h]”h ]”h"]”h$]”h&]”uh1j¬  hj²	  hžhhŸh¶h Nubj­  )”}”(hŒQThe contribution is subjected to the same test regimen as all
other submissions.
”h]”h¸)”}”(hŒPThe contribution is subjected to the same test regimen as all
other submissions.”h]”hŒPThe contribution is subjected to the same test regimen as all
other submissions.”…””}”(hj
  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1h·hŸh¶h M¡hjý	  ubah}”(h]”h ]”h"]”h$]”h&]”uh1j¬  hj²	  hžhhŸh¶h Nubj­  )”}”(hŒmAn indication (via a Generated-by: tag or otherwise) that the
contribution is LLM-generated is not required.
”h]”h¸)”}”(hŒlAn indication (via a Generated-by: tag or otherwise) that the
contribution is LLM-generated is not required.”h]”hŒlAn indication (via a Generated-by: tag or otherwise) that the
contribution is LLM-generated is not required.”…””}”(hj
  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1h·hŸh¶h M¤hj
  ubah}”(h]”h ]”h"]”h$]”h&]”uh1j¬  hj²	  hžhhŸh¶h Nubeh}”(h]”h ]”h"]”h$]”h&]”j  j  uh1j§  hŸh¶h M–hj“	  hžhubh¸)”}”(hŒ½It is easy to address review comments and fix requests in LLM
generated code. So easy, in fact, that it becomes tempting to repost
refreshed code immediately. Please resist that temptation.”h]”hŒ½It is easy to address review comments and fix requests in LLM
generated code. So easy, in fact, that it becomes tempting to repost
refreshed code immediately. Please resist that temptation.”…””}”(hj3
  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1h·hŸh¶h M§hj“	  hžhubh¸)”}”(hŒQAs always, please avoid reposting series revisions more than once
every 24 hours.”h]”hŒQAs always, please avoid reposting series revisions more than once
every 24 hours.”…””}”(hjA
  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1h·hŸh¶h M«hj“	  hžhubeh}”(h]”Œllm-generated-submissions”ah ]”h"]”Œllm-generated submissions”ah$]”h&]”uh1h¡hj  hžhhŸh¶h Mubh¢)”}”(hhh]”(h§)”}”(hŒClean-up patches”h]”hŒClean-up patches”…””}”(hjZ
  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1h¦hjW
  hžhhŸh¶h M¯ubh¸)”}”(hŒThe NFSD maintainers discourage patches which perform simple clean-
ups, which are not in the context of other work. For example:”h]”hŒThe NFSD maintainers discourage patches which perform simple clean-
ups, which are not in the context of other work. For example:”…””}”(hjh
  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1h·hŸh¶h M°hjW
  hžhubj¨  )”}”(hhh]”(j­  )”}”(hŒ1Addressing ``checkpatch.pl`` warnings after merge”h]”h¸)”}”(hj{
  h]”(hŒAddressing ”…””}”(hj}
  hžhhŸNh Nubje  )”}”(hŒ``checkpatch.pl``”h]”hŒcheckpatch.pl”…””}”(hj„
  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1jd  hj}
  ubhŒ warnings after merge”…””}”(hj}
  hžhhŸNh Nubeh}”(h]”h ]”h"]”h$]”h&]”uh1h·hŸh¶h M³hjy
  ubah}”(h]”h ]”h"]”h$]”h&]”uh1j¬  hjv
  hžhhŸh¶h Nubj­  )”}”(hŒ5Addressing :ref:`Local variable ordering<rcs>` issues”h]”h¸)”}”(hj¤
  h]”(hŒAddressing ”…””}”(hj¦
  hžhhŸNh Nubh)”}”(hŒ#:ref:`Local variable ordering<rcs>`”h]”hŒinline”“”)”}”(hj¯
  h]”hŒLocal variable ordering”…””}”(hj³
  hžhhŸNh Nubah}”(h]”h ]”(Œxref”Œstd”Œstd-ref”eh"]”h$]”h&]”uh1j±
  hj­
  ubah}”(h]”h ]”h"]”h$]”h&]”Œrefdoc”Œ-filesystems/nfs/nfsd-maintainer-entry-profile”Œ	refdomain”j¾
  Œreftype”Œref”Œrefexplicit”ˆŒrefwarn”ˆŒ	reftarget”Œrcs”uh1hhŸh¶h M´hj¦
  ubhŒ issues”…””}”(hj¦
  hžhhŸNh Nubeh}”(h]”h ]”h"]”h$]”h&]”uh1h·hŸh¶h M´hj¢
  ubah}”(h]”h ]”h"]”h$]”h&]”uh1j¬  hjv
  hžhhŸh¶h Nubj­  )”}”(hŒ+Addressing long-standing whitespace damage
”h]”h¸)”}”(hŒ*Addressing long-standing whitespace damage”h]”hŒ*Addressing long-standing whitespace damage”…””}”(hjæ
  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1h·hŸh¶h Mµhjâ
  ubah}”(h]”h ]”h"]”h$]”h&]”uh1j¬  hjv
  hžhhŸh¶h Nubeh}”(h]”h ]”h"]”h$]”h&]”j  Œ*”uh1j§  hŸh¶h M³hjW
  hžhubh¸)”}”(hŒ}This is because it is felt that the churn that such changes produce
comes at a greater cost than the value of such clean-ups.”h]”hŒ}This is because it is felt that the churn that such changes produce
comes at a greater cost than the value of such clean-ups.”…””}”(hj  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1h·hŸh¶h M·hjW
  hžhubh¸)”}”(hŒ6Conversely, spelling and grammar fixes are encouraged.”h]”hŒ6Conversely, spelling and grammar fixes are encouraged.”…””}”(hj  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1h·hŸh¶h MºhjW
  hžhubeh}”(h]”Œclean-up-patches”ah ]”h"]”Œclean-up patches”ah$]”h&]”uh1h¡hj  hžhhŸh¶h M¯ubeh}”(h]”Œcontributor-s-guide”ah ]”h"]”Œcontributor's guide”ah$]”h&]”uh1h¡hh£hžhhŸh¶h K;ubh¢)”}”(hhh]”(h§)”}”(hŒStable and LTS support”h]”hŒStable and LTS support”…””}”(hj0  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1h¦hj-  hžhhŸh¶h M½ubh¸)”}”(hŒ^Upstream NFSD continuous integration testing runs against LTS trees
whenever they are updated.”h]”hŒ^Upstream NFSD continuous integration testing runs against LTS trees
whenever they are updated.”…””}”(hj>  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1h·hŸh¶h M¾hj-  hžhubh¸)”}”(hŒ‚Please indicate when a patch containing a fix needs to be considered
for LTS kernels, either via a Fixes: tag or explicit mention.”h]”hŒ‚Please indicate when a patch containing a fix needs to be considered
for LTS kernels, either via a Fixes: tag or explicit mention.”…””}”(hjL  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1h·hŸh¶h MÁhj-  hžhubeh}”(h]”Œstable-and-lts-support”ah ]”h"]”Œstable and lts support”ah$]”h&]”uh1h¡hh£hžhhŸh¶h M½ubh¢)”}”(hhh]”(h§)”}”(hŒFeature requests”h]”hŒFeature requests”…””}”(hje  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1h¦hjb  hžhhŸh¶h MÅubh¸)”}”(hŒÊThere is no one way to make an official feature request, but
discussion about the request should eventually make its way to
the linux-nfs@vger.kernel.org mailing list for public review by
the community.”h]”(hŒ€There is no one way to make an official feature request, but
discussion about the request should eventually make its way to
the ”…””}”(hjs  hžhhŸNh Nubj  )”}”(hŒlinux-nfs@vger.kernel.org”h]”hŒlinux-nfs@vger.kernel.org”…””}”(hj{  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”Œrefuri”Œ mailto:linux-nfs@vger.kernel.org”uh1j  hjs  ubhŒ1 mailing list for public review by
the community.”…””}”(hjs  hžhhŸNh Nubeh}”(h]”h ]”h"]”h$]”h&]”uh1h·hŸh¶h MÆhjb  hžhubh¢)”}”(hhh]”(h§)”}”(hŒSubsystem boundaries”h]”hŒSubsystem boundaries”…””}”(hj˜  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1h¦hj•  hžhhŸh¶h MÌubh¸)”}”(hXC  NFSD itself is not much more than a protocol engine. This means its
primary responsibility is to translate the NFS protocol into API
calls in the Linux kernel. For example, NFSD is not responsible for
knowing exactly how bytes or file attributes are managed on a block
device. It relies on other kernel subsystems for that.”h]”hXC  NFSD itself is not much more than a protocol engine. This means its
primary responsibility is to translate the NFS protocol into API
calls in the Linux kernel. For example, NFSD is not responsible for
knowing exactly how bytes or file attributes are managed on a block
device. It relies on other kernel subsystems for that.”…””}”(hj¦  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1h·hŸh¶h MÍhj•  hžhubh¸)”}”(hX   If the subsystems on which NFSD relies do not implement a particular
feature, even if the standard NFS protocols do support that feature,
that usually means NFSD cannot provide that feature without
substantial development work in other areas of the kernel.”h]”hX   If the subsystems on which NFSD relies do not implement a particular
feature, even if the standard NFS protocols do support that feature,
that usually means NFSD cannot provide that feature without
substantial development work in other areas of the kernel.”…””}”(hj´  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1h·hŸh¶h MÓhj•  hžhubeh}”(h]”Œsubsystem-boundaries”ah ]”h"]”Œsubsystem boundaries”ah$]”h&]”uh1h¡hjb  hžhhŸh¶h MÌubh¢)”}”(hhh]”(h§)”}”(hŒSpecificity”h]”hŒSpecificity”…””}”(hjÍ  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1h¦hjÊ  hžhhŸh¶h MÙubh¸)”}”(hXO  Feature requests can come from anywhere, and thus can often be
nebulous. A requester might not understand what a "use case" or
"user story" is. These descriptive paradigms are often used by
developers and architects to understand what is required of a
design, but are terms of art in the software trade, not used in
the everyday world.”h]”hXW  Feature requests can come from anywhere, and thus can often be
nebulous. A requester might not understand what a â€œuse caseâ€ or
â€œuser storyâ€ is. These descriptive paradigms are often used by
developers and architects to understand what is required of a
design, but are terms of art in the software trade, not used in
the everyday world.”…””}”(hjÛ  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1h·hŸh¶h MÚhjÊ  hžhubh¸)”}”(hŒ’In order to prevent contributors and maintainers from becoming
overwhelmed, we won't be afraid of saying "no" politely to
underspecified requests.”h]”hŒ˜In order to prevent contributors and maintainers from becoming
overwhelmed, we wonâ€™t be afraid of saying â€œnoâ€ politely to
underspecified requests.”…””}”(hjé  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1h·hŸh¶h MáhjÊ  hžhubeh}”(h]”Œspecificity”ah ]”h"]”Œspecificity”ah$]”h&]”uh1h¡hjb  hžhhŸh¶h MÙubeh}”(h]”Œfeature-requests”ah ]”h"]”Œfeature requests”ah$]”h&]”uh1h¡hh£hžhhŸh¶h MÅubh¢)”}”(hhh]”(h§)”}”(hŒ#Community roles and their authority”h]”hŒ#Community roles and their authority”…””}”(hj
  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1h¦hj  hžhhŸh¶h Mæubh¸)”}”(hŒÄThe purpose of Linux subsystem communities is to provide expertise
and active stewardship of a narrow set of source files in the Linux
kernel. This can include managing user space tooling as well.”h]”hŒÄThe purpose of Linux subsystem communities is to provide expertise
and active stewardship of a narrow set of source files in the Linux
kernel. This can include managing user space tooling as well.”…””}”(hj  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1h·hŸh¶h Mçhj  hžhubh¸)”}”(hŒžTo contextualize the structure of the Linux NFS community that
is responsible for stewardship of the NFS server code base, we
define the community roles here.”h]”hŒžTo contextualize the structure of the Linux NFS community that
is responsible for stewardship of the NFS server code base, we
define the community roles here.”…””•¸3      }”(hj&  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1h·hŸh¶h Mëhj  hžhubj¨  )”}”(hhh]”(j­  )”}”(hŒŸ**Contributor** : Anyone who submits a code change, bug fix,
recommendation, documentation fix, and so on. A contributor can
submit regularly or infrequently.
”h]”h¸)”}”(hŒž**Contributor** : Anyone who submits a code change, bug fix,
recommendation, documentation fix, and so on. A contributor can
submit regularly or infrequently.”h]”(hŒstrong”“”)”}”(hŒ**Contributor**”h]”hŒContributor”…””}”(hjA  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1j?  hj;  ubhŒ : Anyone who submits a code change, bug fix,
recommendation, documentation fix, and so on. A contributor can
submit regularly or infrequently.”…””}”(hj;  hžhhŸNh Nubeh}”(h]”h ]”h"]”h$]”h&]”uh1h·hŸh¶h Mïhj7  ubah}”(h]”h ]”h"]”h$]”h&]”uh1j¬  hj4  hžhhŸh¶h Nubj­  )”}”(hŒì**Outside Contributor** : A contributor who is not a regular actor
in the Linux NFS community. This can mean someone who contributes
to other parts of the kernel, or someone who just noticed a
misspelling in a comment and sent a patch.
”h]”h¸)”}”(hŒë**Outside Contributor** : A contributor who is not a regular actor
in the Linux NFS community. This can mean someone who contributes
to other parts of the kernel, or someone who just noticed a
misspelling in a comment and sent a patch.”h]”(j@  )”}”(hŒ**Outside Contributor**”h]”hŒOutside Contributor”…””}”(hjg  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1j?  hjc  ubhŒÔ : A contributor who is not a regular actor
in the Linux NFS community. This can mean someone who contributes
to other parts of the kernel, or someone who just noticed a
misspelling in a comment and sent a patch.”…””}”(hjc  hžhhŸNh Nubeh}”(h]”h ]”h"]”h$]”h&]”uh1h·hŸh¶h Móhj_  ubah}”(h]”h ]”h"]”h$]”h&]”uh1j¬  hj4  hžhhŸh¶h Nubj­  )”}”(hŒÁ**Reviewer** : Someone who is named in the MAINTAINERS file as a
reviewer is an area expert who can request changes to contributed
code, and expects that contributors will address the request.
”h]”h¸)”}”(hŒÀ**Reviewer** : Someone who is named in the MAINTAINERS file as a
reviewer is an area expert who can request changes to contributed
code, and expects that contributors will address the request.”h]”(j@  )”}”(hŒ**Reviewer**”h]”hŒReviewer”…””}”(hj  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1j?  hj‰  ubhŒ´ : Someone who is named in the MAINTAINERS file as a
reviewer is an area expert who can request changes to contributed
code, and expects that contributors will address the request.”…””}”(hj‰  hžhhŸNh Nubeh}”(h]”h ]”h"]”h$]”h&]”uh1h·hŸh¶h Møhj…  ubah}”(h]”h ]”h"]”h$]”h&]”uh1j¬  hj4  hžhhŸh¶h Nubj­  )”}”(hX  **External Reviewer** : Someone who is not named in the
MAINTAINERS file as a reviewer, but who is an area expert.
Examples include Linux kernel contributors with networking,
security, or persistent storage expertise, or developers who
contribute primarily to other NFS implementations.
”h]”h¸)”}”(hX  **External Reviewer** : Someone who is not named in the
MAINTAINERS file as a reviewer, but who is an area expert.
Examples include Linux kernel contributors with networking,
security, or persistent storage expertise, or developers who
contribute primarily to other NFS implementations.”h]”(j@  )”}”(hŒ**External Reviewer**”h]”hŒExternal Reviewer”…””}”(hj³  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1j?  hj¯  ubhX	   : Someone who is not named in the
MAINTAINERS file as a reviewer, but who is an area expert.
Examples include Linux kernel contributors with networking,
security, or persistent storage expertise, or developers who
contribute primarily to other NFS implementations.”…””}”(hj¯  hžhhŸNh Nubeh}”(h]”h ]”h"]”h$]”h&]”uh1h·hŸh¶h Mühj«  ubah}”(h]”h ]”h"]”h$]”h&]”uh1j¬  hj4  hžhhŸh¶h Nubeh}”(h]”h ]”h"]”h$]”h&]”j  j  uh1j§  hŸh¶h Mïhj  hžhubh¸)”}”(hŒÌOne or more people will take on the following roles. These people
are often generically referred to as "maintainers", and are
identified in the MAINTAINERS file with the "M:" tag under the NFSD
subsystem.”h]”hŒÔOne or more people will take on the following roles. These people
are often generically referred to as â€œmaintainersâ€, and are
identified in the MAINTAINERS file with the â€œM:â€ tag under the NFSD
subsystem.”…””}”(hj×  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1h·hŸh¶h Mhj  hžhubj¨  )”}”(hhh]”(j­  )”}”(hŒõ**Upstream Release Manager** : This role is responsible for
curating contributions into a branch, reviewing test results, and
then sending a pull request during merge windows. There is a
trust relationship between the release manager and Linus.
”h]”h¸)”}”(hŒô**Upstream Release Manager** : This role is responsible for
curating contributions into a branch, reviewing test results, and
then sending a pull request during merge windows. There is a
trust relationship between the release manager and Linus.”h]”(j@  )”}”(hŒ**Upstream Release Manager**”h]”hŒUpstream Release Manager”…””}”(hjð  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1j?  hjì  ubhŒØ : This role is responsible for
curating contributions into a branch, reviewing test results, and
then sending a pull request during merge windows. There is a
trust relationship between the release manager and Linus.”…””}”(hjì  hžhhŸNh Nubeh}”(h]”h ]”h"]”h$]”h&]”uh1h·hŸh¶h Mhjè  ubah}”(h]”h ]”h"]”h$]”h&]”uh1j¬  hjå  hžhhŸh¶h Nubj­  )”}”(hŒ«**Bug Triager** : Someone who is a first responder to bug reports
submitted to the linux-nfs mailing list or bug trackers, and helps
troubleshoot and identify next steps.
”h]”h¸)”}”(hŒª**Bug Triager** : Someone who is a first responder to bug reports
submitted to the linux-nfs mailing list or bug trackers, and helps
troubleshoot and identify next steps.”h]”(j@  )”}”(hŒ**Bug Triager**”h]”hŒBug Triager”…””}”(hj  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1j?  hj  ubhŒ› : Someone who is a first responder to bug reports
submitted to the linux-nfs mailing list or bug trackers, and helps
troubleshoot and identify next steps.”…””}”(hj  hžhhŸNh Nubeh}”(h]”h ]”h"]”h$]”h&]”uh1h·hŸh¶h Mhj  ubah}”(h]”h ]”h"]”h$]”h&]”uh1j¬  hjå  hžhhŸh¶h Nubj­  )”}”(hX1  **Security Lead** : The security lead handles contacts from the
security community to resolve immediate issues, as well as dealing
with long-term security issues such as supply chain concerns. For
upstream, that's usually whether contributions violate licensing
or other intellectual property agreements.
”h]”h¸)”}”(hX0  **Security Lead** : The security lead handles contacts from the
security community to resolve immediate issues, as well as dealing
with long-term security issues such as supply chain concerns. For
upstream, that's usually whether contributions violate licensing
or other intellectual property agreements.”h]”(j@  )”}”(hŒ**Security Lead**”h]”hŒSecurity Lead”…””}”(hj<  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1j?  hj8  ubhX!   : The security lead handles contacts from the
security community to resolve immediate issues, as well as dealing
with long-term security issues such as supply chain concerns. For
upstream, thatâ€™s usually whether contributions violate licensing
or other intellectual property agreements.”…””}”(hj8  hžhhŸNh Nubeh}”(h]”h ]”h"]”h$]”h&]”uh1h·hŸh¶h Mhj4  ubah}”(h]”h ]”h"]”h$]”h&]”uh1j¬  hjå  hžhhŸh¶h Nubj­  )”}”(hŒ¸**Testing Lead** : The testing lead builds and runs the test
infrastructure for the subsystem. The testing lead may ask for
patches to be dropped because of ongoing high defect rates.
”h]”h¸)”}”(hŒ·**Testing Lead** : The testing lead builds and runs the test
infrastructure for the subsystem. The testing lead may ask for
patches to be dropped because of ongoing high defect rates.”h]”(j@  )”}”(hŒ**Testing Lead**”h]”hŒTesting Lead”…””}”(hjb  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1j?  hj^  ubhŒ§ : The testing lead builds and runs the test
infrastructure for the subsystem. The testing lead may ask for
patches to be dropped because of ongoing high defect rates.”…””}”(hj^  hžhhŸNh Nubeh}”(h]”h ]”h"]”h$]”h&]”uh1h·hŸh¶h MhjZ  ubah}”(h]”h ]”h"]”h$]”h&]”uh1j¬  hjå  hžhhŸh¶h Nubj­  )”}”(hŒì**LTS Maintainer** : The LTS maintainer is responsible for managing
the Fixes: and Cc: stable annotations on patches, and seeing that
patches that cannot be automatically applied to LTS kernels get
proper manual backports as necessary.
”h]”h¸)”}”(hŒë**LTS Maintainer** : The LTS maintainer is responsible for managing
the Fixes: and Cc: stable annotations on patches, and seeing that
patches that cannot be automatically applied to LTS kernels get
proper manual backports as necessary.”h]”(j@  )”}”(hŒ**LTS Maintainer**”h]”hŒLTS Maintainer”…””}”(hjˆ  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1j?  hj„  ubhŒÙ : The LTS maintainer is responsible for managing
the Fixes: and Cc: stable annotations on patches, and seeing that
patches that cannot be automatically applied to LTS kernels get
proper manual backports as necessary.”…””}”(hj„  hžhhŸNh Nubeh}”(h]”h ]”h"]”h$]”h&]”uh1h·hŸh¶h Mhj€  ubah}”(h]”h ]”h"]”h$]”h&]”uh1j¬  hjå  hžhhŸh¶h Nubj­  )”}”(hX  **Community Manager** : This umpire role can be asked to call balls
and strikes during conflicts, but is also responsible for ensuring
the health of the relationships within the community and for
facilitating discussions on long-term topics such as how to manage
growing technical debt.”h]”h¸)”}”(hX  **Community Manager** : This umpire role can be asked to call balls
and strikes during conflicts, but is also responsible for ensuring
the health of the relationships within the community and for
facilitating discussions on long-term topics such as how to manage
growing technical debt.”h]”(j@  )”}”(hŒ**Community Manager**”h]”hŒCommunity Manager”…””}”(hj®  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1j?  hjª  ubhX	   : This umpire role can be asked to call balls
and strikes during conflicts, but is also responsible for ensuring
the health of the relationships within the community and for
facilitating discussions on long-term topics such as how to manage
growing technical debt.”…””}”(hjª  hžhhŸNh Nubeh}”(h]”h ]”h"]”h$]”h&]”uh1h·hŸh¶h Mhj¦  ubah}”(h]”h ]”h"]”h$]”h&]”uh1j¬  hjå  hžhhŸh¶h Nubeh}”(h]”h ]”h"]”h$]”h&]”j  j  uh1j§  hŸh¶h Mhj  hžhubeh}”(h]”Œ#community-roles-and-their-authority”ah ]”h"]”Œ#community roles and their authority”ah$]”h&]”uh1h¡hh£hžhhŸh¶h Mæubeh}”(h]”Œnfsd-maintainer-entry-profile”ah ]”h"]”Œnfsd maintainer entry profile”ah$]”h&]”uh1h¡hhhžhhŸh¶h Kubeh}”(h]”h ]”h"]”h$]”h&]”Œsource”h¶uh1hŒcurrent_source”NŒcurrent_line”NŒsettings”Œdocutils.frontend”ŒValues”“”)”}”(h¦NŒ	generator”NŒ	datestamp”NŒsource_link”NŒ
source_url”NŒtoc_backlinks”Œentry”Œfootnote_backlinks”KŒsectnum_xform”KŒstrip_comments”NŒstrip_elements_with_classes”NŒstrip_classes”NŒreport_level”KŒ
halt_level”KŒexit_status_level”KŒdebug”NŒwarning_stream”NŒ	traceback”ˆŒinput_encoding”Œ	utf-8-sig”Œinput_encoding_error_handler”Œstrict”Œoutput_encoding”Œutf-8”Œoutput_encoding_error_handler”j  Œerror_encoding”Œutf-8”Œerror_encoding_error_handler”Œbackslashreplace”Œlanguage_code”Œen”Œrecord_dependencies”NŒconfig”NŒ	id_prefix”hŒauto_id_prefix”Œid”Œdump_settings”NŒdump_internals”NŒdump_transforms”NŒdump_pseudo_xml”NŒexpose_internals”NŒstrict_visitor”NŒ_disable_config”NŒ_source”h¶Œ_destination”NŒ_config_files”]”Œ7/var/lib/git/docbuild/linux/Documentation/docutils.conf”aŒfile_insertion_enabled”ˆŒraw_enabled”KŒline_length_limit”M'Œpep_references”NŒpep_base_url”Œhttps://peps.python.org/”Œpep_file_url_template”Œpep-%04d”Œrfc_references”NŒrfc_base_url”Œ&https://datatracker.ietf.org/doc/html/”Œ	tab_width”KŒtrim_footnote_reference_space”‰Œsyntax_highlight”Œlong”Œsmart_quotes”ˆŒsmartquotes_locales”]”Œcharacter_level_inline_markup”‰Œdoctitle_xform”‰Œdocinfo_xform”KŒsectsubtitle_xform”‰Œimage_loading”Œlink”Œembed_stylesheet”‰Œcloak_email_addresses”ˆŒsection_self_link”‰Œenv”NubŒreporter”NŒindirect_targets”]”Œsubstitution_defs”}”Œsubstitution_names”}”Œrefnames”}”Œrefids”}”Œnameids”}”(jß  jÜ  hùhöjx  ju  jV  jS  j  j  j*  j'  j…  j‚  j®  j«  j†  jƒ  jÝ  jÚ  jã  jà  jé  jæ  j4  j1  j?	  j<	  j	  j	  jT
  jQ
  j"  j  j_  j\  j  j  jÇ  jÄ  jü  jù  j×  jÔ  uŒ	nametypes”}”(jß  ‰hù‰jx  ‰jV  ˆj  ‰j*  ‰j…  ‰j®  ‰j†  ‰jÝ  ‰jã  ‰jé  ‰j4  ‰j?	  ‰j	  ‰jT
  ‰j"  ‰j_  ‰j  ‰jÇ  ‰jü  ‰j×  ‰uh}”(jÜ  h£höhÇju  hüjS  jM  j  j{  j'  j  j‚  j)  j«  jˆ  jƒ  j±  jÚ  j‰  jà  jà  jæ  jæ  j1  jì  j<	  j7  j	  jB	  jQ
  j“	  j  jW
  j\  j-  j  jb  jÄ  j•  jù  jÊ  jÔ  j  uŒfootnote_refs”}”Œcitation_refs”}”Œautofootnotes”]”Œautofootnote_refs”]”Œsymbol_footnotes”]”Œsymbol_footnote_refs”]”Œ	footnotes”]”Œ	citations”]”Œautofootnote_start”KŒsymbol_footnote_start”K Œ
id_counter”Œcollections”ŒCounter”“”}”…”R”Œparse_messages”]”Œtransform_messages”]”Œtransformer”NŒinclude_log”]”Œ
decoration”Nhžhub.