Talk:NewNfsManPage
From Linux NFS
Chucklever (Talk | contribs) (→Things that might be hard to add) |
Chucklever (Talk | contribs) (→To Do) |
||
| Line 6: | Line 6: | ||
# Expand the SECURITY CONSIDERATIONS section | # Expand the SECURITY CONSIDERATIONS section | ||
| - | |||
| - | |||
# Add more useful examples, such as mounting /usr with ro,nolock,nocto | # Add more useful examples, such as mounting /usr with ro,nolock,nocto | ||
| - | |||
# Refine the discussion of various options | # Refine the discussion of various options | ||
| - | |||
| - | |||
# Check for spelling, grammar, punctuation, style, and typography | # Check for spelling, grammar, punctuation, style, and typography | ||
# Review with mailing list | # Review with mailing list | ||
# Review with LDP | # Review with LDP | ||
| + | |||
| + | == Possible additions == | ||
| + | |||
| + | * Add a section discussing NFSROOT | ||
| + | ** within scope if NFSROOT mounts are also described in /etc/fstab; are they discussed outside of linux/Documentation/ ? | ||
| + | * Add some information about /etc/mtab and how it is used by umount.nfs | ||
| + | ** possibly better added to '''umount.nfs'''(8) | ||
| + | * Add a section discussing how to mount through a firewall | ||
| + | ** I can't think of a better place to add this than '''nfs'''(5) | ||
| + | * Add a section discussing "-o remount" -- which options don't work as expected over a remount | ||
| + | ** not sure where to place this information | ||
| + | * Add a section or two covering NFS server configuration (/etc/exports, exportfs) | ||
| + | ** not within the scope of '''nfs'''(5) | ||
== Things that might be hard to add == | == Things that might be hard to add == | ||
Revision as of 19:37, 4 September 2007
Let's try hashing out changes here before they go into the new nfs(5) man page.
Contents |
To Do
- Expand the SECURITY CONSIDERATIONS section
- Add more useful examples, such as mounting /usr with ro,nolock,nocto
- Refine the discussion of various options
- Check for spelling, grammar, punctuation, style, and typography
- Review with mailing list
- Review with LDP
Possible additions
- Add a section discussing NFSROOT
- within scope if NFSROOT mounts are also described in /etc/fstab; are they discussed outside of linux/Documentation/ ?
- Add some information about /etc/mtab and how it is used by umount.nfs
- possibly better added to umount.nfs(8)
- Add a section discussing how to mount through a firewall
- I can't think of a better place to add this than nfs(5)
- Add a section discussing "-o remount" -- which options don't work as expected over a remount
- not sure where to place this information
- Add a section or two covering NFS server configuration (/etc/exports, exportfs)
- not within the scope of nfs(5)
Things that might be hard to add
Gbarazer suggests adding details on starting and stopping NFS services. I'm not sure how to incorporate details on starting and stopping NFS services. The initscripts that manage this are in a totally different package, and are often different among the various distributions. Another area of weak documentation that arguably belongs in nfs(5) is the use of /etc/sysconfig/nfs, but I think that is a Red Hat specific configuration file.
What is the scope of this man page? I don't think it's all of NFS. The SYNOPSIS suggests it is only for describing the format of /etc/fstab; thus we should probably leave out server-related items.
The noac, intr, and nocto options
I moved these options again because:
1. I don't think nfs4 supports the nocto option, so I moved it out of the "all versions" section into the "nfs only section"
2. The default behavior of "intr" is currently different between "nfs" and "nfs4", so I moved it out of the "all versions" section and into both the "nfs only section" and the "nfs4 only section"
3. I moved the "noac" option initially, but it should work for both "nfs and "nfs4" so I moved it back to the "all versions" section and reworked the description a bit.
