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

docs: cdrom: convert docs to ReST and rename to *.rst

The stuff there is almost already at ReST format. A
conversion for them is trivial: just add a missing titles
and fix some scape codes for them to match ReST syntax.

While here, rename the cdrom-standard.txt, with was converted
from LaTeX to ReST on the previous patch, and add it to the
index file.

At its new index.rst, let's add a :orphan: while this is not linked to
the main index.rst file, in order to avoid build warnings.
Signed-off-by: default avatarMauro Carvalho Chehab <mchehab+samsung@kernel.org>
Signed-off-by: default avatarJonathan Corbet <corbet@lwn.net>
parent e327cfcb
:orphan:
=====
cdrom
=====
.. toctree::
:maxdepth: 1
cdrom-standard
ide-cd
packet-writing
.. only:: subproject and html
Indices
=======
* :ref:`genindex`
==============
Packet writing
==============
Getting started quick Getting started quick
--------------------- ---------------------
...@@ -10,13 +14,16 @@ Getting started quick ...@@ -10,13 +14,16 @@ Getting started quick
Download from http://sourceforge.net/projects/linux-udf/ Download from http://sourceforge.net/projects/linux-udf/
- Grab a new CD-RW disc and format it (assuming CD-RW is hdc, substitute - Grab a new CD-RW disc and format it (assuming CD-RW is hdc, substitute
as appropriate): as appropriate)::
# cdrwtool -d /dev/hdc -q # cdrwtool -d /dev/hdc -q
- Setup your writer - Setup your writer::
# pktsetup dev_name /dev/hdc # pktsetup dev_name /dev/hdc
- Now you can mount /dev/pktcdvd/dev_name and copy files to it. Enjoy! - Now you can mount /dev/pktcdvd/dev_name and copy files to it. Enjoy::
# mount /dev/pktcdvd/dev_name /cdrom -t udf -o rw,noatime # mount /dev/pktcdvd/dev_name /cdrom -t udf -o rw,noatime
...@@ -25,11 +32,11 @@ Packet writing for DVD-RW media ...@@ -25,11 +32,11 @@ Packet writing for DVD-RW media
DVD-RW discs can be written to much like CD-RW discs if they are in DVD-RW discs can be written to much like CD-RW discs if they are in
the so called "restricted overwrite" mode. To put a disc in restricted the so called "restricted overwrite" mode. To put a disc in restricted
overwrite mode, run: overwrite mode, run::
# dvd+rw-format /dev/hdc # dvd+rw-format /dev/hdc
You can then use the disc the same way you would use a CD-RW disc: You can then use the disc the same way you would use a CD-RW disc::
# pktsetup dev_name /dev/hdc # pktsetup dev_name /dev/hdc
# mount /dev/pktcdvd/dev_name /cdrom -t udf -o rw,noatime # mount /dev/pktcdvd/dev_name /cdrom -t udf -o rw,noatime
...@@ -41,7 +48,7 @@ Packet writing for DVD+RW media ...@@ -41,7 +48,7 @@ Packet writing for DVD+RW media
According to the DVD+RW specification, a drive supporting DVD+RW discs According to the DVD+RW specification, a drive supporting DVD+RW discs
shall implement "true random writes with 2KB granularity", which means shall implement "true random writes with 2KB granularity", which means
that it should be possible to put any filesystem with a block size >= that it should be possible to put any filesystem with a block size >=
2KB on such a disc. For example, it should be possible to do: 2KB on such a disc. For example, it should be possible to do::
# dvd+rw-format /dev/hdc (only needed if the disc has never # dvd+rw-format /dev/hdc (only needed if the disc has never
been formatted) been formatted)
...@@ -54,7 +61,7 @@ follow the specification, but suffer bad performance problems if the ...@@ -54,7 +61,7 @@ follow the specification, but suffer bad performance problems if the
writes are not 32KB aligned. writes are not 32KB aligned.
Both problems can be solved by using the pktcdvd driver, which always Both problems can be solved by using the pktcdvd driver, which always
generates aligned writes. generates aligned writes::
# dvd+rw-format /dev/hdc # dvd+rw-format /dev/hdc
# pktsetup dev_name /dev/hdc # pktsetup dev_name /dev/hdc
...@@ -83,7 +90,7 @@ Notes ...@@ -83,7 +90,7 @@ Notes
- Since the pktcdvd driver makes the disc appear as a regular block - Since the pktcdvd driver makes the disc appear as a regular block
device with a 2KB block size, you can put any filesystem you like on device with a 2KB block size, you can put any filesystem you like on
the disc. For example, run: the disc. For example, run::
# /sbin/mke2fs /dev/pktcdvd/dev_name # /sbin/mke2fs /dev/pktcdvd/dev_name
...@@ -97,7 +104,7 @@ Since Linux 2.6.20, the pktcdvd module has a sysfs interface ...@@ -97,7 +104,7 @@ Since Linux 2.6.20, the pktcdvd module has a sysfs interface
and can be controlled by it. For example the "pktcdvd" tool uses and can be controlled by it. For example the "pktcdvd" tool uses
this interface. (see http://tom.ist-im-web.de/download/pktcdvd ) this interface. (see http://tom.ist-im-web.de/download/pktcdvd )
"pktcdvd" works similar to "pktsetup", e.g.: "pktcdvd" works similar to "pktsetup", e.g.::
# pktcdvd -a dev_name /dev/hdc # pktcdvd -a dev_name /dev/hdc
# mkudffs /dev/pktcdvd/dev_name # mkudffs /dev/pktcdvd/dev_name
...@@ -115,7 +122,7 @@ For a description of the sysfs interface look into the file: ...@@ -115,7 +122,7 @@ For a description of the sysfs interface look into the file:
Using the pktcdvd debugfs interface Using the pktcdvd debugfs interface
----------------------------------- -----------------------------------
To read pktcdvd device infos in human readable form, do: To read pktcdvd device infos in human readable form, do::
# cat /sys/kernel/debug/pktcdvd/pktcdvd[0-7]/info # cat /sys/kernel/debug/pktcdvd/pktcdvd[0-7]/info
......
...@@ -7610,7 +7610,7 @@ IDE/ATAPI DRIVERS ...@@ -7610,7 +7610,7 @@ IDE/ATAPI DRIVERS
M: Borislav Petkov <bp@alien8.de> M: Borislav Petkov <bp@alien8.de>
L: linux-ide@vger.kernel.org L: linux-ide@vger.kernel.org
S: Maintained S: Maintained
F: Documentation/cdrom/ide-cd F: Documentation/cdrom/ide-cd.rst
F: drivers/ide/ide-cd* F: drivers/ide/ide-cd*
IDEAPAD LAPTOP EXTRAS DRIVER IDEAPAD LAPTOP EXTRAS DRIVER
......
...@@ -347,7 +347,7 @@ config CDROM_PKTCDVD ...@@ -347,7 +347,7 @@ config CDROM_PKTCDVD
is possible. is possible.
DVD-RW disks must be in restricted overwrite mode. DVD-RW disks must be in restricted overwrite mode.
See the file <file:Documentation/cdrom/packet-writing.txt> See the file <file:Documentation/cdrom/packet-writing.rst>
for further information on the use of this driver. for further information on the use of this driver.
To compile this driver as a module, choose M here: the To compile this driver as a module, choose M here: the
......
...@@ -7,7 +7,7 @@ ...@@ -7,7 +7,7 @@
License. See linux/COPYING for more information. License. See linux/COPYING for more information.
Uniform CD-ROM driver for Linux. Uniform CD-ROM driver for Linux.
See Documentation/cdrom/cdrom-standard.txt for usage information. See Documentation/cdrom/cdrom-standard.rst for usage information.
The routines in the file provide a uniform interface between the The routines in the file provide a uniform interface between the
software that uses CD-ROMs and the various low-level drivers that software that uses CD-ROMs and the various low-level drivers that
......
...@@ -9,7 +9,7 @@ ...@@ -9,7 +9,7 @@
* May be copied or modified under the terms of the GNU General Public * May be copied or modified under the terms of the GNU General Public
* License. See linux/COPYING for more information. * License. See linux/COPYING for more information.
* *
* See Documentation/cdrom/ide-cd for usage information. * See Documentation/cdrom/ide-cd.rst for usage information.
* *
* Suggestions are welcome. Patches that work are more welcome though. ;-) * Suggestions are welcome. Patches that work are more welcome though. ;-)
* *
......
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