Vitor Massaru Iha (2):
Documentation: filesystems: Convert sysfs-pci to ReST
Documentation: filesystems: remove whitespaces
.../{sysfs-pci.txt => sysfs-pci.rst} | 44 ++++++++++---------
1 file changed, 24 insertions(+), 20 deletions(-)
rename Documentation/filesystems/{sysfs-pci.txt => sysfs-pci.rst} (81%)
--
2.21.1
Signed-off-by: Vitor Massaru Iha <[email protected]>
---
Documentation/filesystems/sysfs-pci.rst | 4 ++--
1 file changed, 2 insertions(+), 2 deletions(-)
diff --git a/Documentation/filesystems/sysfs-pci.rst b/Documentation/filesystems/sysfs-pci.rst
index 9b93e7444b15..e4df647ec9db 100644
--- a/Documentation/filesystems/sysfs-pci.rst
+++ b/Documentation/filesystems/sysfs-pci.rst
@@ -71,11 +71,11 @@ don't support mmapping of certain resources, so be sure to check the return
value from any attempted mmap. The most notable of these are I/O port
resources, which also provide read/write access.
-The 'enable' file provides a counter that indicates how many times the device
+The 'enable' file provides a counter that indicates how many times the device
has been enabled. If the 'enable' file currently returns '4', and a '1' is
echoed into it, it will then return '5'. Echoing a '0' into it will decrease
the count. Even when it returns to 0, though, some of the initialisation
-may not be reversed.
+may not be reversed.
The 'rom' file is special in that it provides read-only access to the device's
ROM file, if available. It's disabled by default, however, so applications
--
2.21.1
On Tue, 31 Mar 2020 19:28:55 -0300
Vitor Massaru Iha <[email protected]> wrote:
> Vitor Massaru Iha (2):
> Documentation: filesystems: Convert sysfs-pci to ReST
> Documentation: filesystems: remove whitespaces
>
> .../{sysfs-pci.txt => sysfs-pci.rst} | 44 ++++++++++---------
> 1 file changed, 24 insertions(+), 20 deletions(-)
> rename Documentation/filesystems/{sysfs-pci.txt => sysfs-pci.rst} (81%)
Thanks for working on the documentation! I do have a few comments...
The purpose for including a cover letter on a patch series is to explain
what the series as a whole is trying to accomplish. Without that, it's
not all the helpful.
In this case, there is no real need for a series; just clean up that
trailing whitespace while doing the conversion. (It *is* normally good
practice to separate such conversions from other changes, but that
particular change is trivial enough that you should just do it while
you're there).
When you convert a file to RST, you need to add it to the index.rst file
as well so that it can be a part of the documentation build.
Thanks,
jon
On Tue, 2020-03-31 at 16:49 -0600, Jonathan Corbet wrote:
> On Tue, 31 Mar 2020 19:28:55 -0300
> Vitor Massaru Iha <[email protected]> wrote:
>
> > Vitor Massaru Iha (2):
> > Documentation: filesystems: Convert sysfs-pci to ReST
> > Documentation: filesystems: remove whitespaces
> >
> > .../{sysfs-pci.txt => sysfs-pci.rst} | 44 ++++++++++---------
> > 1 file changed, 24 insertions(+), 20 deletions(-)
> > rename Documentation/filesystems/{sysfs-pci.txt => sysfs-pci.rst} (81%)
[]
> When you convert a file to RST, you need to add it to the index.rst file
> as well so that it can be a part of the documentation build.
And if it's in the MAINTAINERS file, update the file type too.