Commit 98264991 authored by Mauro Carvalho Chehab's avatar Mauro Carvalho Chehab Committed by Jonathan Corbet

docs: filesystems: convert configfs.txt to ReST

- Add a SPDX header;
- Adjust document and section titles;
- Use copyright symbol;
- Some whitespace fixes and new line breaks;
- Mark literal blocks as such;
- Add it to filesystems/index.rst.

Also, as this file is alone on its own dir, and it doesn't
seem too likely that other documents will follow it, let's
move it to the filesystems/ root documentation dir.
Signed-off-by: default avatarMauro Carvalho Chehab <mchehab+huawei@kernel.org>
Link: https://lore.kernel.org/r/c2424ec2ad4d735751434ff7f52144c44aa02d5a.1588021877.git.mchehab+huawei@kernel.orgSigned-off-by: default avatarJonathan Corbet <corbet@lwn.net>
parent fc2f6fe7
...@@ -76,6 +76,7 @@ Documentation for filesystem implementations. ...@@ -76,6 +76,7 @@ Documentation for filesystem implementations.
cifs/cifsroot cifs/cifsroot
ceph ceph
coda coda
configfs
cramfs cramfs
debugfs debugfs
dlmfs dlmfs
......
...@@ -9,7 +9,7 @@ Configfs is a filesystem-based manager of kernel objects. IIO uses some ...@@ -9,7 +9,7 @@ Configfs is a filesystem-based manager of kernel objects. IIO uses some
objects that could be easily configured using configfs (e.g.: devices, objects that could be easily configured using configfs (e.g.: devices,
triggers). triggers).
See Documentation/filesystems/configfs/configfs.txt for more information See Documentation/filesystems/configfs.rst for more information
about how configfs works. about how configfs works.
2. Usage 2. Usage
......
...@@ -24,7 +24,7 @@ Linux provides a number of functions for gadgets to use. ...@@ -24,7 +24,7 @@ Linux provides a number of functions for gadgets to use.
Creating a gadget means deciding what configurations there will be Creating a gadget means deciding what configurations there will be
and which functions each configuration will provide. and which functions each configuration will provide.
Configfs (please see `Documentation/filesystems/configfs/*`) lends itself nicely Configfs (please see `Documentation/filesystems/configfs.rst`) lends itself nicely
for the purpose of telling the kernel about the above mentioned decision. for the purpose of telling the kernel about the above mentioned decision.
This document is about how to do it. This document is about how to do it.
...@@ -354,7 +354,7 @@ the directories in general can be named at will. A group can have ...@@ -354,7 +354,7 @@ the directories in general can be named at will. A group can have
a number of its default sub-groups created automatically. a number of its default sub-groups created automatically.
For more information on configfs please see For more information on configfs please see
`Documentation/filesystems/configfs/*`. `Documentation/filesystems/configfs.rst`.
The concepts described above translate to USB gadgets like this: The concepts described above translate to USB gadgets like this:
......
...@@ -9,7 +9,7 @@ ...@@ -9,7 +9,7 @@
* *
* configfs Copyright (C) 2005 Oracle. All rights reserved. * configfs Copyright (C) 2005 Oracle. All rights reserved.
* *
* Please see Documentation/filesystems/configfs/configfs.txt for more * Please see Documentation/filesystems/configfs.rst for more
* information. * information.
*/ */
......
...@@ -9,7 +9,7 @@ ...@@ -9,7 +9,7 @@
* *
* configfs Copyright (C) 2005 Oracle. All rights reserved. * configfs Copyright (C) 2005 Oracle. All rights reserved.
* *
* Please see the file Documentation/filesystems/configfs/configfs.txt for * Please see the file Documentation/filesystems/configfs.rst for
* critical information about using the config_item interface. * critical information about using the config_item interface.
*/ */
......
...@@ -13,7 +13,7 @@ ...@@ -13,7 +13,7 @@
* *
* configfs Copyright (C) 2005 Oracle. All rights reserved. * configfs Copyright (C) 2005 Oracle. All rights reserved.
* *
* Please read Documentation/filesystems/configfs/configfs.txt before using * Please read Documentation/filesystems/configfs.rst before using
* the configfs interface, ESPECIALLY the parts about reference counts and * the configfs interface, ESPECIALLY the parts about reference counts and
* item destructors. * item destructors.
*/ */
......
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment