From: Mauro Carvalho Chehab <mchehab+samsung@kernel.org>
To: Linux Doc Mailing List <linux-doc@vger.kernel.org>
Cc: Mauro Carvalho Chehab <mchehab+samsung@kernel.org>,
Mauro Carvalho Chehab <mchehab@infradead.org>,
linux-kernel@vger.kernel.org, Jonathan Corbet <corbet@lwn.net>
Subject: [PATCH v1 05/31] docs: cma/debugfs.txt: convert docs to ReST and rename to *.rst
Date: Wed, 12 Jun 2019 15:38:08 -0300 [thread overview]
Message-ID: <6604fe1bbc206c11e6b2d8e6b379bbb0c163c556.1560364494.git.mchehab+samsung@kernel.org> (raw)
In-Reply-To: <cover.1560364493.git.mchehab+samsung@kernel.org>
The debugfs interface for CMA should be there together with other
mm-related documents.
Convert this small file to ReST and move it to its rightful place.
The conversion is actually quite simple: just add a title for the
document. In order to make it to look better for the audience,
also mark the "echo" command as a literal block.
While this is not part of any book, mark it as :orphan:,
in order to avoid build warnings.
Signed-off-by: Mauro Carvalho Chehab <mchehab+samsung@kernel.org>
---
Documentation/cma/{debugfs.txt => debugfs.rst} | 8 +++++++-
1 file changed, 7 insertions(+), 1 deletion(-)
rename Documentation/cma/{debugfs.txt => debugfs.rst} (91%)
diff --git a/Documentation/cma/debugfs.txt b/Documentation/cma/debugfs.rst
similarity index 91%
rename from Documentation/cma/debugfs.txt
rename to Documentation/cma/debugfs.rst
index 6cef20a8cedc..518fe401b5ee 100644
--- a/Documentation/cma/debugfs.txt
+++ b/Documentation/cma/debugfs.rst
@@ -1,3 +1,9 @@
+:orphan:
+
+=====================
+CMA Debugfs Interface
+=====================
+
The CMA debugfs interface is useful to retrieve basic information out of the
different CMA areas and to test allocation/release in each of the areas.
@@ -12,7 +18,7 @@ The structure of the files created under that directory is as follows:
- [RO] count: Amount of memory in the CMA area.
- [RO] order_per_bit: Order of pages represented by one bit.
- [RO] bitmap: The bitmap of page states in the zone.
- - [WO] alloc: Allocate N pages from that CMA area. For example:
+ - [WO] alloc: Allocate N pages from that CMA area. For example::
echo 5 > <debugfs>/cma/cma-2/alloc
--
2.21.0
next prev parent reply other threads:[~2019-06-12 18:39 UTC|newest]
Thread overview: 38+ messages / expand[flat|nested] mbox.gz Atom feed top
2019-06-12 18:38 [PATCH v1 00/31] Convert files to ReST - part 2 Mauro Carvalho Chehab
2019-06-12 18:38 ` [PATCH v1 01/31] docs: connector: convert to ReST and rename to connector.rst Mauro Carvalho Chehab
2019-06-12 18:38 ` [PATCH v1 02/31] docs: lcd-panel-cgram.txt: convert docs to ReST and rename to *.rst Mauro Carvalho Chehab
2019-06-12 18:38 ` [PATCH v1 03/31] docs: lp855x-driver.txt: convert to ReST and move to kernel-api Mauro Carvalho Chehab
2019-06-12 18:38 ` [PATCH v1 04/31] docs: m68k: convert docs to ReST and rename to *.rst Mauro Carvalho Chehab
2019-06-12 18:38 ` Mauro Carvalho Chehab [this message]
2019-06-12 18:38 ` [PATCH v1 06/31] docs: console.txt: " Mauro Carvalho Chehab
2019-06-12 18:38 ` [PATCH v1 07/31] docs: pti_intel_mid.txt: convert it to pti_intel_mid.rst Mauro Carvalho Chehab
2019-06-12 18:38 ` [PATCH v1 08/31] docs: early-userspace: convert docs to ReST and rename to *.rst Mauro Carvalho Chehab
2019-06-12 18:38 ` [PATCH v1 09/31] docs: driver-model: " Mauro Carvalho Chehab
2019-06-12 20:21 ` Jeff Kirsher
2019-06-12 18:38 ` [PATCH v1 11/31] docs: memory-devices: convert ti-emif.txt to ReST Mauro Carvalho Chehab
2019-06-12 18:38 ` [PATCH v1 12/31] docs: xen-tpmfront.txt: convert it to .rst Mauro Carvalho Chehab
2019-06-12 18:38 ` [PATCH v1 13/31] docs: bus-devices: ti-gpmc.rst: convert it to ReST Mauro Carvalho Chehab
2019-06-12 18:38 ` [PATCH v1 14/31] docs: nvmem: convert docs to ReST and rename to *.rst Mauro Carvalho Chehab
2019-06-12 18:38 ` [PATCH v1 15/31] docs: phy: convert samsung-usb2.txt to ReST format Mauro Carvalho Chehab
2019-06-12 18:38 ` [PATCH v1 16/31] docs: rbtree.txt: fix Sphinx build warnings Mauro Carvalho Chehab
2019-06-12 18:38 ` [PATCH v1 17/31] docs: DMA-API-HOWTO.txt: fix an unmarked code block Mauro Carvalho Chehab
2019-06-12 18:38 ` [PATCH v1 18/31] docs: accounting: convert to ReST Mauro Carvalho Chehab
2019-06-12 18:38 ` [PATCH v1 19/31] docs: fmc: " Mauro Carvalho Chehab
2019-06-12 18:38 ` [PATCH v1 20/31] docs: hid: " Mauro Carvalho Chehab
2019-06-13 8:08 ` Benjamin Tissoires
2019-06-13 9:52 ` Mauro Carvalho Chehab
2019-06-12 18:38 ` [PATCH v1 21/31] docs: ia64: " Mauro Carvalho Chehab
2019-06-12 18:38 ` [PATCH v1 22/31] docs: leds: " Mauro Carvalho Chehab
2019-06-12 18:38 ` [PATCH v1 23/31] docs: laptops: " Mauro Carvalho Chehab
2019-06-12 20:19 ` Andy Shevchenko
2019-06-12 18:38 ` [PATCH v1 24/31] docs: iio: " Mauro Carvalho Chehab
2019-06-16 13:47 ` Jonathan Cameron
2019-06-12 18:38 ` [PATCH v1 25/31] docs: namespaces: " Mauro Carvalho Chehab
2019-06-12 18:38 ` [PATCH v1 26/31] docs: nfc: " Mauro Carvalho Chehab
2019-06-12 18:38 ` [PATCH v1 27/31] docs: md: " Mauro Carvalho Chehab
2019-06-12 18:38 ` [PATCH v1 28/31] docs: mtd: " Mauro Carvalho Chehab
2019-06-12 18:38 ` [PATCH v1 29/31] docs: nvdimm: " Mauro Carvalho Chehab
2019-06-12 19:04 ` Dan Williams
2019-06-12 20:41 ` Mauro Carvalho Chehab
2019-06-12 18:38 ` [PATCH v1 30/31] docs: xtensa: " Mauro Carvalho Chehab
2019-06-12 18:38 ` [PATCH v1 31/31] docs: mmc: " Mauro Carvalho Chehab
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=6604fe1bbc206c11e6b2d8e6b379bbb0c163c556.1560364494.git.mchehab+samsung@kernel.org \
--to=mchehab+samsung@kernel.org \
--cc=corbet@lwn.net \
--cc=linux-doc@vger.kernel.org \
--cc=linux-kernel@vger.kernel.org \
--cc=mchehab@infradead.org \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).