Thread: [Linux-NTFS-Dev] [PATCH 00/30] Standardize doc formats - part 2
Development moved to https://sourceforge.net/projects/ntfs-3g/
Brought to you by:
antona,
cha0smaster
From: Mauro C. C. <mc...@s-...> - 2017-05-19 01:24:34
|
Each document under Documentation/*.txt has its own format. Some follow markup notations, some don't even have a title! In order to try to get some order on it, change the document style to the standard we're adopting after the adoption of ReStructured Text. The documents touched on this series now build fine with Sphinx, if renamed to *.rst extension. The main goal with this is to teach people by example about what format is expected on newer documents. It also helps to add those files to Kernel books. In order to make things more palatable, I'm spliting the conversion into three parts. This is part 2. Mauro Carvalho Chehab (30): iostats.txt: update it to cover recent Kernels IPMI.txt: standardize document format IRQ-affinity.txt: standardize document format IRQ-domain.txt: standardize document format irqflags-tracing.txt: standardize document format IRQ.txt: add a markup for its title isapnp.txt: promote title level isa.txt: standardize document format kernel-per-CPU-kthreads.txt: standardize document format kobject.txt: standardize document format kprobes.txt: standardize document format kref.txt: standardize document format kselftest.txt: standardize document format ldm.txt: standardize document format lockup-watchdogs.txt: standardize document format lzo.txt: standardize document format mailbox.txt: standardize document format memory-barriers.txt: standardize document format memory-barriers.txt: use literals for variables memory-hotplug.txt: standardize document format men-chameleon-bus.txt: standardize document format nommu-mmap.txt: standardize document format nommu-mmap.txt: don't use all upper case on titles ntb.txt: standardize document format numastat.txt: standardize document format padata.txt: standardize document format parport-lowlevel.txt: standardize document format percpu-rw-semaphore.txt: standardize document format phy.txt: standardize document format pi-futex.txt: standardize document format Documentation/IPMI.txt | 76 +- Documentation/IRQ-affinity.txt | 77 +- Documentation/IRQ-domain.txt | 69 +- Documentation/IRQ.txt | 2 + Documentation/iostats.txt | 44 +- Documentation/irqflags-tracing.txt | 10 +- Documentation/isa.txt | 53 +- Documentation/isapnp.txt | 1 + Documentation/kernel-per-CPU-kthreads.txt | 156 +++- Documentation/kobject.txt | 69 +- Documentation/kprobes.txt | 450 ++++++---- Documentation/kref.txt | 285 ++++--- Documentation/kselftest.txt | 37 +- Documentation/ldm.txt | 54 +- Documentation/lockup-watchdogs.txt | 3 +- Documentation/lzo.txt | 27 +- Documentation/mailbox.txt | 181 ++-- Documentation/memory-barriers.txt | 794 +++++++++--------- Documentation/memory-hotplug.txt | 357 ++++---- Documentation/men-chameleon-bus.txt | 298 +++---- Documentation/nommu-mmap.txt | 68 +- Documentation/ntb.txt | 55 +- Documentation/numastat.txt | 5 +- Documentation/padata.txt | 27 +- Documentation/parport-lowlevel.txt | 1303 ++++++++++++++++++----------- Documentation/percpu-rw-semaphore.txt | 3 +- Documentation/phy.txt | 106 ++- Documentation/pi-futex.txt | 15 +- 28 files changed, 2683 insertions(+), 1942 deletions(-) -- 2.9.4 |
From: Mauro C. C. <mc...@s-...> - 2017-05-19 01:24:36
|
Each text file under Documentation follows a different format. Some doesn't even have titles! Change its representation to follow the adopted standard, using ReST markups for it to be parseable by Sphinx: - Reformat its title; - Use :Author: and :Last Updated: for authorship - Use note markup; - Reformat table to match ReST standard; - Use bulleted lists where needed. Signed-off-by: Mauro Carvalho Chehab <mc...@s-...> --- Documentation/ldm.txt | 54 +++++++++++++++++++++++++++++++-------------------- 1 file changed, 33 insertions(+), 21 deletions(-) diff --git a/Documentation/ldm.txt b/Documentation/ldm.txt index 4f80edd14d0a..12c571368e73 100644 --- a/Documentation/ldm.txt +++ b/Documentation/ldm.txt @@ -1,9 +1,9 @@ +========================================== +LDM - Logical Disk Manager (Dynamic Disks) +========================================== - LDM - Logical Disk Manager (Dynamic Disks) - ------------------------------------------ - -Originally Written by FlatCap - Richard Russon <ld...@fl...>. -Last Updated by Anton Altaparmakov on 30 March 2007 for Windows Vista. +:Author: Originally Written by FlatCap - Richard Russon <ld...@fl...>. +:Last Updated: Anton Altaparmakov on 30 March 2007 for Windows Vista. Overview -------- @@ -37,24 +37,36 @@ Example ------- Below we have a 50MiB disk, divided into seven partitions. -N.B. The missing 1MiB at the end of the disk is where the LDM database is - stored. - Device | Offset Bytes Sectors MiB | Size Bytes Sectors MiB - -------+----------------------------+--------------------------- - hda | 0 0 0 | 52428800 102400 50 - hda1 | 51380224 100352 49 | 1048576 2048 1 - hda2 | 16384 32 0 | 6979584 13632 6 - hda3 | 6995968 13664 6 | 10485760 20480 10 - hda4 | 17481728 34144 16 | 4194304 8192 4 - hda5 | 21676032 42336 20 | 5242880 10240 5 - hda6 | 26918912 52576 25 | 10485760 20480 10 - hda7 | 37404672 73056 35 | 13959168 27264 13 +.. note:: + + The missing 1MiB at the end of the disk is where the LDM database is + stored. + ++-------++--------------+---------+-----++--------------+---------+----+ +|Device || Offset Bytes | Sectors | MiB || Size Bytes | Sectors | MiB| ++=======++==============+=========+=====++==============+=========+====+ +|hda || 0 | 0 | 0 || 52428800 | 102400 | 50| ++-------++--------------+---------+-----++--------------+---------+----+ +|hda1 || 51380224 | 100352 | 49 || 1048576 | 2048 | 1| ++-------++--------------+---------+-----++--------------+---------+----+ +|hda2 || 16384 | 32 | 0 || 6979584 | 13632 | 6| ++-------++--------------+---------+-----++--------------+---------+----+ +|hda3 || 6995968 | 13664 | 6 || 10485760 | 20480 | 10| ++-------++--------------+---------+-----++--------------+---------+----+ +|hda4 || 17481728 | 34144 | 16 || 4194304 | 8192 | 4| ++-------++--------------+---------+-----++--------------+---------+----+ +|hda5 || 21676032 | 42336 | 20 || 5242880 | 10240 | 5| ++-------++--------------+---------+-----++--------------+---------+----+ +|hda6 || 26918912 | 52576 | 25 || 10485760 | 20480 | 10| ++-------++--------------+---------+-----++--------------+---------+----+ +|hda7 || 37404672 | 73056 | 35 || 13959168 | 27264 | 13| ++-------++--------------+---------+-----++--------------+---------+----+ The LDM Database may not store the partitions in the order that they appear on disk, but the driver will sort them. -When Linux boots, you will see something like: +When Linux boots, you will see something like:: hda: 102400 sectors w/32KiB Cache, CHS=50/64/32 hda: [LDM] hda1 hda2 hda3 hda4 hda5 hda6 hda7 @@ -65,13 +77,13 @@ Compiling LDM Support To enable LDM, choose the following two options: - "Advanced partition selection" CONFIG_PARTITION_ADVANCED - "Windows Logical Disk Manager (Dynamic Disk) support" CONFIG_LDM_PARTITION + - "Advanced partition selection" CONFIG_PARTITION_ADVANCED + - "Windows Logical Disk Manager (Dynamic Disk) support" CONFIG_LDM_PARTITION If you believe the driver isn't working as it should, you can enable the extra debugging code. This will produce a LOT of output. The option is: - "Windows LDM extra logging" CONFIG_LDM_DEBUG + - "Windows LDM extra logging" CONFIG_LDM_DEBUG N.B. The partition code cannot be compiled as a module. -- 2.9.4 |