* [GIT PULL] doc: sphinx-4.8 DocBook to reST movement on Jon's docs-next
@ 2016-06-28 16:41 Markus Heiser
2016-06-28 19:05 ` Jani Nikula
2016-06-29 16:24 ` Jonathan Corbet
0 siblings, 2 replies; 12+ messages in thread
From: Markus Heiser @ 2016-06-28 16:41 UTC (permalink / raw)
To: corbet, Mauro Carvalho Chehab
Cc: Dave Airlie, Jani Nikula, Markus Heiser, Grant Likely,
Keith Packard, LKML Mailing List, linux-doc, Hans Verkuil,
Randy Dunlap
Hi Jonathan, hi Mauro,
here is my DocBook to reST movement on top of Jon's docs-next branch. It includes:
* kernel-doc parser & directive
* flat-table directive
* man page builder 'kernel-doc-man'
* the kernel-doc-HOWTO
* guides for starters (reST-nano-HOWTO.rst & template-book)
* A index-page which bundles the lose Documentation/*.rst files.
* sub sphinx-projects aka *books* under Documentation/*/conf.py
* a full DocBook-XML to reST migration (*books* matching
Documentation/books_migrated/*/conf.py) described in [2]. The migration is
based on the DocBook-XML content at commit 17defc2 from Johnatan's docs-next
branch.
I decided to comment out the pdf creation in the Makefile.reST, rst2pdf is to
fragil see [2] (pdf is WIP).
The output of html and man is included in the common %doc targets, to get
more information about reST builds use:
make books-help
Any comments are welcome.
-- Markus --
[1] http://return42.github.io/sphkerneldoc/articles/dbtools.html
[2] https://github.com/rst2pdf/rst2pdf/issues/556#issuecomment-228779542
The following changes since commit 17defc282fe6e6ac93edbad8873ce89ef86b2490:
Documentation: add meta-documentation for Sphinx and kernel-doc (2016-06-24 06:55:28 -0600)
are available in the git repository at:
https://github.com/return42/linux.git docs-next/linux-doc-reST
for you to fetch changes up to 81bd813a599f8582570a735302ab660e20c7f442:
doc-rst: full DocBook-XML to reST migration (docs-next) (2016-06-28 17:15:38 +0200)
----------------------------------------------------------------
Markus Heiser (15):
python: add scripts/site-packages
kernel-doc-HOWTO: add kernel-doc specification
doc-rst: add python package linuxdoc
doc-rst: kernel-doc parser - inital python implementation
doc-rst: kernel-doc directive - initial implementation
doc-rst: flat-table directive - initial implementation
doc-rst: kernel-doc-man sphinx builder - initial implementation
doc-rst: add basic sphinx-build infrastructure
doc-rst: add template book "Get started with reST"
doc-rst: removed Jani's kernel-documentation.rst and index.rst
doc-rst: infrastructure for *loose reST articles*
doc-rst: add build-html decription to book-help.
doc-rst: kernel-doc parser assert absolute pathname
doc-rst: infrastructure for migrated DocBook-XML
doc-rst: full DocBook-XML to reST migration (docs-next)
Documentation/.gitignore | 1 +
Documentation/Makefile.reST | 261 +
Documentation/article_refs.txt | 23 +
Documentation/books_migrated/80211/AP.rst | 76 +
Documentation/books_migrated/80211/advanced.rst | 37 +
.../books_migrated/80211/aggregation-internals.rst | 33 +
Documentation/books_migrated/80211/aggregation.rst | 47 +
Documentation/books_migrated/80211/basics.rst | 79 +
.../books_migrated/80211/beacon-filter.rst | 28 +
.../80211/cfg80211-developers-guide-000-001.rst | 141 +
.../80211/cfg80211-developers-guide-000-002.rst | 231 +
.../80211/cfg80211-developers-guide-000-003.rst | 71 +
.../80211/cfg80211-developers-guide-000-004.rst | 56 +
.../80211/cfg80211-developers-guide-000-005.rst | 41 +
.../80211/cfg80211-developers-guide-000-006.rst | 36 +
.../80211/cfg80211-developers-guide-000-007.rst | 36 +
.../80211/cfg80211-developers-guide-000-008.rst | 41 +
.../80211/cfg80211-developers-guide.rst | 33 +
Documentation/books_migrated/80211/conf.py | 220 +
Documentation/books_migrated/80211/filters.rst | 28 +
.../80211/hardware-crypto-offload.rst | 53 +
.../books_migrated/80211/hardware-scan-offload.rst | 25 +
.../books_migrated/80211/iface-handling.rst | 37 +
Documentation/books_migrated/80211/index.rst | 67 +
Documentation/books_migrated/80211/internal.rst | 32 +
.../books_migrated/80211/key-handling.rst | 31 +
Documentation/books_migrated/80211/led-support.rst | 58 +
.../80211/mac80211-developers-guide-000-003.rst | 34 +
.../80211/mac80211-developers-guide.rst | 34 +
Documentation/books_migrated/80211/multi-iface.rst | 36 +
.../books_migrated/80211/phy-handling.rst | 33 +
Documentation/books_migrated/80211/powersave.rst | 23 +
Documentation/books_migrated/80211/qos.rst | 25 +
.../books_migrated/80211/rate-control.rst | 28 +
.../books_migrated/80211/ratecontrol-api.rst | 55 +
.../books_migrated/80211/rx-processing.rst | 18 +
Documentation/books_migrated/80211/rx-tx.rst | 178 +
Documentation/books_migrated/80211/smps.rst | 33 +
Documentation/books_migrated/80211/sta-info.rst | 41 +
.../books_migrated/80211/station-handling.rst | 40 +
.../books_migrated/80211/synchronisation.rst | 20 +
.../books_migrated/80211/tx-processing.rst | 18 +
Documentation/books_migrated/80211/workqueue.rst | 33 +
Documentation/books_migrated/README.txt | 44 +
.../books_migrated/alsa-driver-api/conf.py | 219 +
.../alsa-driver-api/index-003-002.rst | 57 +
.../alsa-driver-api/index-003-003.rst | 72 +
.../alsa-driver-api/index-003-004.rst | 53 +
.../alsa-driver-api/index-003-005.rst | 34 +
.../alsa-driver-api/index-003-006.rst | 25 +
.../alsa-driver-api/index-003-007.rst | 40 +
.../alsa-driver-api/index-003-008.rst | 73 +
.../alsa-driver-api/index-003-009.rst | 62 +
.../books_migrated/alsa-driver-api/index.rst | 54 +
Documentation/books_migrated/crypto-API/API.rst | 818 ++
.../books_migrated/crypto-API/Architecture.rst | 455 +
Documentation/books_migrated/crypto-API/Code.rst | 241 +
.../books_migrated/crypto-API/Development.rst | 267 +
Documentation/books_migrated/crypto-API/Intro.rst | 90 +
Documentation/books_migrated/crypto-API/User.rst | 414 +
Documentation/books_migrated/crypto-API/conf.py | 219 +
Documentation/books_migrated/crypto-API/index.rst | 63 +
Documentation/books_migrated/debugobjects/bugs.rst | 18 +
Documentation/books_migrated/debugobjects/conf.py | 219 +
.../books_migrated/debugobjects/debugfunctions.rst | 180 +
.../books_migrated/debugobjects/fixupfunctions.rst | 139 +
.../books_migrated/debugobjects/howto.rst | 52 +
.../books_migrated/debugobjects/index.rst | 58 +
.../books_migrated/debugobjects/intro.rst | 31 +
.../books_migrated/device-drivers/Basics.rst | 203 +
.../books_migrated/device-drivers/conf.py | 219 +
.../books_migrated/device-drivers/devdrivers.rst | 216 +
.../books_migrated/device-drivers/fbdev.rst | 90 +
.../books_migrated/device-drivers/hsi.rst | 33 +
.../books_migrated/device-drivers/i2c.rst | 67 +
.../books_migrated/device-drivers/index.rst | 62 +
.../device-drivers/input_subsystem.rst | 93 +
.../books_migrated/device-drivers/mediadev.rst | 214 +
.../device-drivers/message_devices.rst | 62 +
.../books_migrated/device-drivers/parportdev.rst | 38 +
.../books_migrated/device-drivers/pwm.rst | 45 +
.../books_migrated/device-drivers/snddev.rst | 103 +
.../books_migrated/device-drivers/spi.rst | 73 +
.../books_migrated/device-drivers/uart16x50.rst | 28 +
Documentation/books_migrated/deviceiobook/bugs.rst | 18 +
Documentation/books_migrated/deviceiobook/conf.py | 219 +
.../books_migrated/deviceiobook/index.rst | 62 +
.../books_migrated/deviceiobook/intro.rst | 20 +
Documentation/books_migrated/deviceiobook/mmio.rst | 173 +
.../deviceiobook/port_space_accesses.rst | 49 +
.../books_migrated/deviceiobook/pubfunctions.rst | 28 +
.../books_migrated/filesystems/LinuxJDBAPI.rst | 227 +
Documentation/books_migrated/filesystems/conf.py | 219 +
.../books_migrated/filesystems/debugfs.rst | 34 +
.../books_migrated/filesystems/fs_events.rst | 23 +
Documentation/books_migrated/filesystems/index.rst | 57 +
Documentation/books_migrated/filesystems/pipes.rst | 31 +
Documentation/books_migrated/filesystems/proc.rst | 40 +
.../books_migrated/filesystems/splice.rst | 26 +
Documentation/books_migrated/filesystems/sysfs.rst | 28 +
Documentation/books_migrated/filesystems/vfs.rst | 134 +
Documentation/books_migrated/gadget/api.rst | 266 +
Documentation/books_migrated/gadget/conf.py | 219 +
.../books_migrated/gadget/controllers.rst | 47 +
Documentation/books_migrated/gadget/gadget.rst | 64 +
Documentation/books_migrated/gadget/index.rst | 58 +
Documentation/books_migrated/gadget/intro.rst | 67 +
Documentation/books_migrated/gadget/otg.rst | 78 +
Documentation/books_migrated/gadget/structure.rst | 125 +
.../books_migrated/genericirq/Abstraction.rst | 342 +
Documentation/books_migrated/genericirq/bugs.rst | 18 +
Documentation/books_migrated/genericirq/conf.py | 219 +
.../books_migrated/genericirq/credits.rst | 22 +
Documentation/books_migrated/genericirq/doirq.rst | 24 +
.../books_migrated/genericirq/genericchip.rst | 29 +
Documentation/books_migrated/genericirq/index.rst | 69 +
.../books_migrated/genericirq/intfunctions.rst | 36 +
Documentation/books_migrated/genericirq/intro.rst | 28 +
.../books_migrated/genericirq/locking.rst | 20 +
.../books_migrated/genericirq/pubfunctions.rst | 31 +
.../books_migrated/genericirq/rationale.rst | 80 +
.../books_migrated/genericirq/structs.rst | 31 +
Documentation/books_migrated/gpu/api.rst | 74 +
Documentation/books_migrated/gpu/conf.py | 219 +
Documentation/books_migrated/gpu/drmCore.rst | 29 +
Documentation/books_migrated/gpu/drmDrivers.rst | 33 +
Documentation/books_migrated/gpu/drmExternals.rst | 100 +
Documentation/books_migrated/gpu/drmI915.rst | 520 +
Documentation/books_migrated/gpu/drmInternals.rst | 3797 ++++++
.../books_migrated/gpu/drmIntroduction.rst | 65 +
Documentation/books_migrated/gpu/handlers.rst | 68 +
Documentation/books_migrated/gpu/index.rst | 71 +
Documentation/books_migrated/gpu/modes_of_use.rst | 36 +
.../books_migrated/gpu/vga_switcheroo.rst | 39 +
Documentation/books_migrated/iio/conf.py | 223 +
Documentation/books_migrated/iio/iioresources.rst | 41 +
Documentation/books_migrated/iio/iiosubsys.rst | 609 +
Documentation/books_migrated/iio/index.rst | 43 +
Documentation/books_migrated/iio/intro.rst | 44 +
.../books_migrated/kernel-api/accounting.rst | 23 +
Documentation/books_migrated/kernel-api/adt.rst | 27 +
Documentation/books_migrated/kernel-api/audit.rst | 33 +
Documentation/books_migrated/kernel-api/blkdev.rst | 88 +
Documentation/books_migrated/kernel-api/chrdev.rst | 23 +
Documentation/books_migrated/kernel-api/clk.rst | 56 +
Documentation/books_migrated/kernel-api/conf.py | 219 +
.../books_migrated/kernel-api/firmware.rst | 36 +
.../books_migrated/kernel-api/hardware.rst | 142 +
Documentation/books_migrated/kernel-api/index.rst | 66 +
Documentation/books_migrated/kernel-api/ipc.rst | 27 +
.../books_migrated/kernel-api/kernel-lib.rst | 95 +
Documentation/books_migrated/kernel-api/kfifo.rst | 27 +
Documentation/books_migrated/kernel-api/libc.rst | 66 +
.../books_migrated/kernel-api/miscdev.rst | 23 +
Documentation/books_migrated/kernel-api/mm.rst | 100 +
.../books_migrated/kernel-api/modload.rst | 31 +
.../books_migrated/kernel-api/relayfs.rst | 36 +
.../books_migrated/kernel-api/security.rst | 28 +
.../books_migrated/kernel-hacking/atomic-ops.rst | 46 +
.../kernel-hacking/basic-players.rst | 123 +
.../books_migrated/kernel-hacking/basic-rules.rst | 43 +
.../books_migrated/kernel-hacking/cantrips.rst | 87 +
.../kernel-hacking/common-routines.rst | 286 +
.../books_migrated/kernel-hacking/conf.py | 219 +
.../books_migrated/kernel-hacking/conventions.rst | 141 +
.../books_migrated/kernel-hacking/credits.rst | 24 +
.../kernel-hacking/deadlock-recipes.rst | 36 +
.../books_migrated/kernel-hacking/index.rst | 67 +
.../books_migrated/kernel-hacking/introduction.rst | 29 +
.../books_migrated/kernel-hacking/ioctls.rst | 67 +
.../books_migrated/kernel-hacking/queues.rst | 60 +
.../books_migrated/kernel-hacking/submitting.rst | 53 +
.../books_migrated/kernel-hacking/symbols.rst | 45 +
.../books_migrated/kernel-locking/Efficiency.rst | 308 +
.../books_migrated/kernel-locking/Examples.rst | 537 +
.../books_migrated/kernel-locking/apiref-futex.rst | 23 +
.../books_migrated/kernel-locking/apiref-mutex.rst | 28 +
.../books_migrated/kernel-locking/cheatsheet.rst | 266 +
.../kernel-locking/common-problems.rst | 188 +
.../books_migrated/kernel-locking/conf.py | 219 +
.../kernel-locking/hardirq-context.rst | 68 +
.../books_migrated/kernel-locking/index.rst | 126 +
.../books_migrated/kernel-locking/intro.rst | 24 +
.../books_migrated/kernel-locking/locks.rst | 201 +
.../books_migrated/kernel-locking/races.rst | 146 +
.../books_migrated/kernel-locking/references.rst | 27 +
.../kernel-locking/sleeping-things.rst | 69 +
.../books_migrated/kernel-locking/thanks.rst | 25 +
.../kernel-locking/trylock-functions.rst | 33 +
.../books_migrated/kgdb/CommonBackEndReq.rst | 269 +
.../books_migrated/kgdb/CompilingAKernel.rst | 107 +
Documentation/books_migrated/kgdb/EnableKGDB.rst | 113 +
Documentation/books_migrated/kgdb/Introduction.rst | 49 +
.../books_migrated/kgdb/KGDBTestSuite.rst | 33 +
Documentation/books_migrated/kgdb/conf.py | 219 +
Documentation/books_migrated/kgdb/credits.rst | 30 +
Documentation/books_migrated/kgdb/index.rst | 54 +
.../books_migrated/kgdb/kgdbKernelArgs.rst | 239 +
.../books_migrated/kgdb/switchKdbKgdb.rst | 97 +
Documentation/books_migrated/kgdb/usingKDB.rst | 143 +
Documentation/books_migrated/libata/PiixInt.rst | 23 +
Documentation/books_migrated/libata/SILInt.rst | 23 +
.../books_migrated/libata/ataExceptions.rst | 422 +
Documentation/books_migrated/libata/conf.py | 219 +
Documentation/books_migrated/libata/index.rst | 62 +
.../books_migrated/libata/libataDriverApi.rst | 413 +
Documentation/books_migrated/libata/libataEH.rst | 232 +
Documentation/books_migrated/libata/libataExt.rst | 23 +
Documentation/books_migrated/libata/libataInt.rst | 23 +
.../books_migrated/libata/libataIntroduction.rst | 24 +
.../books_migrated/libata/libataScsiInt.rst | 28 +
.../books_migrated/libata/libataThanks.rst | 27 +
Documentation/books_migrated/librs/bugs.rst | 18 +
Documentation/books_migrated/librs/conf.py | 219 +
Documentation/books_migrated/librs/credits.rst | 33 +
Documentation/books_migrated/librs/index.rst | 59 +
Documentation/books_migrated/librs/intro.rst | 25 +
.../books_migrated/librs/pubfunctions.rst | 26 +
Documentation/books_migrated/librs/structs.rst | 27 +
Documentation/books_migrated/librs/usage.rst | 173 +
Documentation/books_migrated/linux_tv/audio.h.rst | 153 +
Documentation/books_migrated/linux_tv/ca.h.rst | 108 +
Documentation/books_migrated/linux_tv/conf.py | 221 +
Documentation/books_migrated/linux_tv/dmx.h.rst | 173 +
.../books_migrated/linux_tv/frontend.h.rst | 620 +
Documentation/books_migrated/linux_tv/index.rst | 100 +
.../media/dvb/FE_DISHNETWORK_SEND_LEGACY_CMD.rst | 55 +
.../linux_tv/media/dvb/FE_GET_EVENT.rst | 89 +
.../linux_tv/media/dvb/FE_GET_FRONTEND.rst | 77 +
.../linux_tv/media/dvb/FE_READ_BER.rst | 61 +
.../linux_tv/media/dvb/FE_READ_SIGNAL_STRENGTH.rst | 64 +
.../linux_tv/media/dvb/FE_READ_SNR.rst | 61 +
.../media/dvb/FE_READ_UNCORRECTED_BLOCKS.rst | 66 +
.../linux_tv/media/dvb/FE_SET_FRONTEND.rst | 84 +
.../books_migrated/linux_tv/media/dvb/audio.rst | 37 +
.../linux_tv/media/dvb/audio_data_types.rst | 187 +
.../linux_tv/media/dvb/audio_function_calls.rst | 1308 +++
.../books_migrated/linux_tv/media/dvb/audio_h.rst | 24 +
.../books_migrated/linux_tv/media/dvb/ca.rst | 29 +
.../linux_tv/media/dvb/ca_data_types.rst | 121 +
.../linux_tv/media/dvb/ca_function_calls.rst | 541 +
.../books_migrated/linux_tv/media/dvb/ca_h.rst | 24 +
.../books_migrated/linux_tv/media/dvb/demux.rst | 29 +
.../linux_tv/media/dvb/dmx_fcalls.rst | 1013 ++
.../books_migrated/linux_tv/media/dvb/dmx_h.rst | 24 +
.../linux_tv/media/dvb/dmx_types.rst | 253 +
.../linux_tv/media/dvb/dtv-fe-stats.rst | 28 +
.../linux_tv/media/dvb/dtv-properties.rst | 26 +
.../linux_tv/media/dvb/dtv-property.rst | 42 +
.../linux_tv/media/dvb/dtv-stats.rst | 29 +
.../linux_tv/media/dvb/dvb-fe-read-status.rst | 31 +
.../linux_tv/media/dvb/dvb-frontend-event.rst | 26 +
.../linux_tv/media/dvb/dvb-frontend-parameters.rst | 130 +
.../books_migrated/linux_tv/media/dvb/dvbapi.rst | 95 +
.../linux_tv/media/dvb/dvbproperty-006.rst | 21 +
.../linux_tv/media/dvb/dvbproperty.rst | 122 +
.../books_migrated/linux_tv/media/dvb/examples.rst | 391 +
.../linux_tv/media/dvb/fe-bandwidth-t.rst | 88 +
.../media/dvb/fe-diseqc-recv-slave-reply.rst | 88 +
.../media/dvb/fe-diseqc-reset-overload.rst | 51 +
.../linux_tv/media/dvb/fe-diseqc-send-burst.rst | 93 +
.../media/dvb/fe-diseqc-send-master-cmd.rst | 78 +
.../media/dvb/fe-enable-high-lnb-voltage.rst | 58 +
.../linux_tv/media/dvb/fe-get-info.rst | 434 +
.../linux_tv/media/dvb/fe-get-property.rst | 75 +
.../linux_tv/media/dvb/fe-read-status.rst | 143 +
.../media/dvb/fe-set-frontend-tune-mode.rst | 60 +
.../linux_tv/media/dvb/fe-set-tone.rst | 100 +
.../linux_tv/media/dvb/fe-set-voltage.rst | 68 +
.../linux_tv/media/dvb/fe-type-t.rst | 100 +
.../linux_tv/media/dvb/fe_property_parameters.rst | 1976 ++++
.../media/dvb/frontend-property-cable-systems.rst | 84 +
.../dvb/frontend-property-satellite-systems.rst | 112 +
.../dvb/frontend-property-terrestrial-systems.rst | 303 +
.../media/dvb/frontend-stat-properties.rst | 254 +
.../books_migrated/linux_tv/media/dvb/frontend.rst | 62 +
.../linux_tv/media/dvb/frontend_f_close.rst | 55 +
.../linux_tv/media/dvb/frontend_f_open.rst | 108 +
.../linux_tv/media/dvb/frontend_fcalls.rst | 35 +
.../linux_tv/media/dvb/frontend_h.rst | 24 +
.../linux_tv/media/dvb/frontend_legacy_api.rst | 49 +
.../media/dvb/frontend_legacy_dvbv3_api.rst | 29 +
.../books_migrated/linux_tv/media/dvb/intro.rst | 204 +
.../linux_tv/media/dvb/intro_files/dvbstb.pdf | Bin 0 -> 1881 bytes
.../linux_tv/media/dvb/intro_files/dvbstb.png | Bin 0 -> 22655 bytes
.../linux_tv/media/dvb/legacy_dvb_apis.rst | 31 +
.../books_migrated/linux_tv/media/dvb/net.rst | 219 +
.../books_migrated/linux_tv/media/dvb/net_h.rst | 24 +
.../linux_tv/media/dvb/query-dvb-frontend-info.rst | 22 +
.../books_migrated/linux_tv/media/dvb/video.rst | 46 +
.../linux_tv/media/dvb/video_function_calls.rst | 1880 +++
.../books_migrated/linux_tv/media/dvb/video_h.rst | 24 +
.../linux_tv/media/dvb/video_types.rst | 390 +
.../media/v4l/Remote_controllers_Intro.rst | 33 +
.../media/v4l/Remote_controllers_table_change.rst | 29 +
.../media/v4l/Remote_controllers_tables.rst | 768 ++
.../books_migrated/linux_tv/media/v4l/app-pri.rst | 39 +
.../books_migrated/linux_tv/media/v4l/async.rst | 18 +
.../books_migrated/linux_tv/media/v4l/audio.rst | 97 +
.../books_migrated/linux_tv/media/v4l/biblio.rst | 390 +
.../books_migrated/linux_tv/media/v4l/buffer.rst | 966 ++
.../linux_tv/media/v4l/capture-example.rst | 24 +
.../linux_tv/media/v4l/capture.c.rst | 675 ++
.../linux_tv/media/v4l/colorspaces.rst | 172 +
.../linux_tv/media/v4l/common-defs.rst | 24 +
.../books_migrated/linux_tv/media/v4l/common.rst | 56 +
.../books_migrated/linux_tv/media/v4l/compat.rst | 29 +
.../books_migrated/linux_tv/media/v4l/control.rst | 536 +
.../books_migrated/linux_tv/media/v4l/controls.rst | 18 +
.../books_migrated/linux_tv/media/v4l/crop.rst | 300 +
.../linux_tv/media/v4l/crop_files/crop.gif | Bin 0 -> 5967 bytes
.../linux_tv/media/v4l/crop_files/crop.pdf | Bin 0 -> 5846 bytes
.../linux_tv/media/v4l/depth-formats.rst | 26 +
.../linux_tv/media/v4l/dev-capture.rst | 111 +
.../linux_tv/media/v4l/dev-codec.rst | 41 +
.../linux_tv/media/v4l/dev-effect.rst | 31 +
.../linux_tv/media/v4l/dev-event.rst | 56 +
.../books_migrated/linux_tv/media/v4l/dev-osd.rst | 154 +
.../linux_tv/media/v4l/dev-output.rst | 108 +
.../linux_tv/media/v4l/dev-overlay.rst | 328 +
.../linux_tv/media/v4l/dev-radio.rst | 61 +
.../linux_tv/media/v4l/dev-raw-vbi.rst | 368 +
.../media/v4l/dev-raw-vbi_files/vbi_525.gif | Bin 0 -> 4741 bytes
.../media/v4l/dev-raw-vbi_files/vbi_525.pdf | Bin 0 -> 3395 bytes
.../media/v4l/dev-raw-vbi_files/vbi_625.gif | Bin 0 -> 5095 bytes
.../media/v4l/dev-raw-vbi_files/vbi_625.pdf | Bin 0 -> 3683 bytes
.../media/v4l/dev-raw-vbi_files/vbi_hsync.gif | Bin 0 -> 2400 bytes
.../media/v4l/dev-raw-vbi_files/vbi_hsync.pdf | Bin 0 -> 7405 bytes
.../books_migrated/linux_tv/media/v4l/dev-rds.rst | 266 +
.../books_migrated/linux_tv/media/v4l/dev-sdr.rst | 129 +
.../linux_tv/media/v4l/dev-sliced-vbi.rst | 804 ++
.../linux_tv/media/v4l/dev-subdev.rst | 502 +
.../media/v4l/dev-subdev_files/pipeline.pdf | Bin 0 -> 20276 bytes
.../media/v4l/dev-subdev_files/pipeline.png | Bin 0 -> 12130 bytes
.../subdev-image-processing-crop.pdf | Bin 0 -> 20729 bytes
.../subdev-image-processing-crop.svg | 63 +
.../subdev-image-processing-full.pdf | Bin 0 -> 46311 bytes
.../subdev-image-processing-full.svg | 163 +
...ubdev-image-processing-scaling-multi-source.pdf | Bin 0 -> 36714 bytes
...ubdev-image-processing-scaling-multi-source.svg | 116 +
.../linux_tv/media/v4l/dev-teletext.rst | 43 +
.../books_migrated/linux_tv/media/v4l/devices.rst | 37 +
.../books_migrated/linux_tv/media/v4l/diff-v4l.rst | 963 ++
.../books_migrated/linux_tv/media/v4l/dmabuf.rst | 158 +
.../books_migrated/linux_tv/media/v4l/driver.rst | 18 +
.../linux_tv/media/v4l/dv-timings.rst | 47 +
.../linux_tv/media/v4l/extended-controls.rst | 4533 +++++++
.../linux_tv/media/v4l/fdl-appendix.rst | 487 +
.../linux_tv/media/v4l/field-order.rst | 210 +
.../media/v4l/field-order_files/fieldseq_bt.gif | Bin 0 -> 25430 bytes
.../media/v4l/field-order_files/fieldseq_bt.pdf | Bin 0 -> 9185 bytes
.../media/v4l/field-order_files/fieldseq_tb.gif | Bin 0 -> 25323 bytes
.../media/v4l/field-order_files/fieldseq_tb.pdf | Bin 0 -> 9173 bytes
.../books_migrated/linux_tv/media/v4l/format.rst | 101 +
.../linux_tv/media/v4l/func-close.rst | 56 +
.../linux_tv/media/v4l/func-ioctl.rst | 69 +
.../linux_tv/media/v4l/func-mmap.rst | 141 +
.../linux_tv/media/v4l/func-munmap.rst | 65 +
.../linux_tv/media/v4l/func-open.rst | 90 +
.../linux_tv/media/v4l/func-poll.rst | 118 +
.../linux_tv/media/v4l/func-read.rst | 138 +
.../linux_tv/media/v4l/func-select.rst | 108 +
.../linux_tv/media/v4l/func-write.rst | 89 +
.../linux_tv/media/v4l/gen-errors.rst | 109 +
.../linux_tv/media/v4l/hist-v4l2.rst | 1490 +++
.../books_migrated/linux_tv/media/v4l/io.rst | 62 +
.../linux_tv/media/v4l/keytable.c.rst | 187 +
.../linux_tv/media/v4l/libv4l-introduction.rst | 178 +
.../books_migrated/linux_tv/media/v4l/libv4l.rst | 24 +
.../linux_tv/media/v4l/lirc_dev_intro.rst | 37 +
.../linux_tv/media/v4l/lirc_device_interface.rst | 26 +
.../linux_tv/media/v4l/lirc_ioctl.rst | 165 +
.../linux_tv/media/v4l/lirc_read.rst | 28 +
.../linux_tv/media/v4l/lirc_write.rst | 23 +
.../linux_tv/media/v4l/media-controller-intro.rst | 42 +
.../linux_tv/media/v4l/media-controller-model.rst | 44 +
.../linux_tv/media/v4l/media-controller.rst | 66 +
.../linux_tv/media/v4l/media-func-close.rst | 54 +
.../linux_tv/media/v4l/media-func-ioctl.rst | 74 +
.../linux_tv/media/v4l/media-func-open.rst | 76 +
.../linux_tv/media/v4l/media-ioc-device-info.rst | 149 +
.../linux_tv/media/v4l/media-ioc-enum-entities.rst | 204 +
.../linux_tv/media/v4l/media-ioc-enum-links.rst | 180 +
.../linux_tv/media/v4l/media-ioc-g-topology.rst | 436 +
.../linux_tv/media/v4l/media-ioc-setup-link.rst | 75 +
.../linux_tv/media/v4l/media-types.rst | 433 +
.../books_migrated/linux_tv/media/v4l/mmap.rst | 286 +
.../books_migrated/linux_tv/media/v4l/open.rst | 168 +
.../linux_tv/media/v4l/pixfmt-002.rst | 207 +
.../linux_tv/media/v4l/pixfmt-003.rst | 177 +
.../linux_tv/media/v4l/pixfmt-004.rst | 60 +
.../linux_tv/media/v4l/pixfmt-006.rst | 291 +
.../linux_tv/media/v4l/pixfmt-007.rst | 870 ++
.../linux_tv/media/v4l/pixfmt-008.rst | 41 +
.../linux_tv/media/v4l/pixfmt-013.rst | 140 +
.../linux_tv/media/v4l/pixfmt-grey.rst | 89 +
.../linux_tv/media/v4l/pixfmt-indexed.rst | 84 +
.../linux_tv/media/v4l/pixfmt-m420.rst | 238 +
.../linux_tv/media/v4l/pixfmt-nv12.rst | 241 +
.../linux_tv/media/v4l/pixfmt-nv12m.rst | 256 +
.../linux_tv/media/v4l/pixfmt-nv12mt.rst | 71 +
.../media/v4l/pixfmt-nv12mt_files/nv12mt.gif | Bin 0 -> 2108 bytes
.../v4l/pixfmt-nv12mt_files/nv12mt_example.gif | Bin 0 -> 6858 bytes
.../linux_tv/media/v4l/pixfmt-nv16.rst | 290 +
.../linux_tv/media/v4l/pixfmt-nv16m.rst | 297 +
.../linux_tv/media/v4l/pixfmt-nv24.rst | 182 +
.../linux_tv/media/v4l/pixfmt-packed-rgb.rst | 1479 +++
.../linux_tv/media/v4l/pixfmt-packed-yuv.rst | 325 +
.../linux_tv/media/v4l/pixfmt-reserved.rst | 371 +
.../linux_tv/media/v4l/pixfmt-rgb.rst | 34 +
.../linux_tv/media/v4l/pixfmt-sbggr16.rst | 125 +
.../linux_tv/media/v4l/pixfmt-sbggr8.rst | 93 +
.../linux_tv/media/v4l/pixfmt-sdr-cs08.rst | 55 +
.../linux_tv/media/v4l/pixfmt-sdr-cs14le.rst | 60 +
.../linux_tv/media/v4l/pixfmt-sdr-cu08.rst | 55 +
.../linux_tv/media/v4l/pixfmt-sdr-cu16le.rst | 59 +
.../linux_tv/media/v4l/pixfmt-sdr-ru12le.rst | 50 +
.../linux_tv/media/v4l/pixfmt-sgbrg8.rst | 93 +
.../linux_tv/media/v4l/pixfmt-sgrbg8.rst | 93 +
.../linux_tv/media/v4l/pixfmt-srggb10.rst | 129 +
.../linux_tv/media/v4l/pixfmt-srggb10alaw8.rst | 32 +
.../linux_tv/media/v4l/pixfmt-srggb10dpcm8.rst | 33 +
.../linux_tv/media/v4l/pixfmt-srggb10p.rst | 112 +
.../linux_tv/media/v4l/pixfmt-srggb12.rst | 129 +
.../linux_tv/media/v4l/pixfmt-srggb8.rst | 93 +
.../linux_tv/media/v4l/pixfmt-uv8.rst | 88 +
.../linux_tv/media/v4l/pixfmt-uyvy.rst | 216 +
.../linux_tv/media/v4l/pixfmt-vyuy.rst | 216 +
.../linux_tv/media/v4l/pixfmt-y10.rst | 122 +
.../linux_tv/media/v4l/pixfmt-y10b.rst | 56 +
.../linux_tv/media/v4l/pixfmt-y12.rst | 122 +
.../linux_tv/media/v4l/pixfmt-y12i.rst | 59 +
.../linux_tv/media/v4l/pixfmt-y16-be.rst | 123 +
.../linux_tv/media/v4l/pixfmt-y16.rst | 123 +
.../linux_tv/media/v4l/pixfmt-y41p.rst | 313 +
.../linux_tv/media/v4l/pixfmt-y8i.rst | 123 +
.../linux_tv/media/v4l/pixfmt-yuv410.rst | 219 +
.../linux_tv/media/v4l/pixfmt-yuv411p.rst | 237 +
.../linux_tv/media/v4l/pixfmt-yuv420.rst | 250 +
.../linux_tv/media/v4l/pixfmt-yuv420m.rst | 265 +
.../linux_tv/media/v4l/pixfmt-yuv422m.rst | 274 +
.../linux_tv/media/v4l/pixfmt-yuv422p.rst | 257 +
.../linux_tv/media/v4l/pixfmt-yuv444m.rst | 294 +
.../linux_tv/media/v4l/pixfmt-yuyv.rst | 217 +
.../linux_tv/media/v4l/pixfmt-yvyu.rst | 216 +
.../linux_tv/media/v4l/pixfmt-z16.rst | 123 +
.../books_migrated/linux_tv/media/v4l/pixfmt.rst | 46 +
.../linux_tv/media/v4l/planar-apis.rst | 74 +
.../books_migrated/linux_tv/media/v4l/querycap.rst | 43 +
.../linux_tv/media/v4l/remote_controllers.rst | 53 +
.../media/v4l/remote_controllers_sysfs_nodes.rst | 152 +
.../books_migrated/linux_tv/media/v4l/rw.rst | 56 +
.../linux_tv/media/v4l/sdr-formats.rst | 30 +
.../linux_tv/media/v4l/selection-api-002.rst | 37 +
.../linux_tv/media/v4l/selection-api-003.rst | 29 +
.../v4l/selection-api-003_files/selection.png | Bin 0 -> 11716 bytes
.../linux_tv/media/v4l/selection-api-004.rst | 146 +
.../linux_tv/media/v4l/selection-api-005.rst | 42 +
.../linux_tv/media/v4l/selection-api-006.rst | 89 +
.../linux_tv/media/v4l/selection-api.rst | 27 +
.../linux_tv/media/v4l/selections-common.rst | 34 +
.../books_migrated/linux_tv/media/v4l/standard.rst | 185 +
.../linux_tv/media/v4l/streaming-par.rst | 42 +
.../linux_tv/media/v4l/subdev-formats.rst | 11701 +++++++++++++++++++
.../media/v4l/subdev-formats_files/bayer.png | Bin 0 -> 9725 bytes
.../books_migrated/linux_tv/media/v4l/tuner.rst | 91 +
.../linux_tv/media/v4l/user-func.rst | 92 +
.../books_migrated/linux_tv/media/v4l/userp.rst | 123 +
.../linux_tv/media/v4l/v4l2-selection-flags.rst | 82 +
.../linux_tv/media/v4l/v4l2-selection-targets.rst | 146 +
.../books_migrated/linux_tv/media/v4l/v4l2.rst | 392 +
.../linux_tv/media/v4l/v4l2grab-example.rst | 28 +
.../linux_tv/media/v4l/v4l2grab.c.rst | 180 +
.../books_migrated/linux_tv/media/v4l/video.rst | 73 +
.../books_migrated/linux_tv/media/v4l/videodev.rst | 24 +
.../linux_tv/media/v4l/vidioc-create-bufs.rst | 154 +
.../linux_tv/media/v4l/vidioc-cropcap.rst | 175 +
.../linux_tv/media/v4l/vidioc-dbg-g-chip-info.rst | 212 +
.../linux_tv/media/v4l/vidioc-dbg-g-register.rst | 218 +
.../linux_tv/media/v4l/vidioc-decoder-cmd.rst | 280 +
.../linux_tv/media/v4l/vidioc-dqevent.rst | 581 +
.../linux_tv/media/v4l/vidioc-dv-timings-cap.rst | 259 +
.../linux_tv/media/v4l/vidioc-encoder-cmd.rst | 204 +
.../linux_tv/media/v4l/vidioc-enum-dv-timings.rst | 128 +
.../linux_tv/media/v4l/vidioc-enum-fmt.rst | 172 +
.../media/v4l/vidioc-enum-frameintervals.rst | 282 +
.../linux_tv/media/v4l/vidioc-enum-framesizes.rst | 299 +
.../linux_tv/media/v4l/vidioc-enum-freq-bands.rst | 198 +
.../linux_tv/media/v4l/vidioc-enumaudio.rst | 63 +
.../linux_tv/media/v4l/vidioc-enumaudioout.rst | 66 +
.../linux_tv/media/v4l/vidioc-enuminput.rst | 375 +
.../linux_tv/media/v4l/vidioc-enumoutput.rst | 230 +
.../linux_tv/media/v4l/vidioc-enumstd.rst | 450 +
.../linux_tv/media/v4l/vidioc-expbuf.rst | 205 +
.../linux_tv/media/v4l/vidioc-g-audio.rst | 171 +
.../linux_tv/media/v4l/vidioc-g-audioout.rst | 131 +
.../linux_tv/media/v4l/vidioc-g-crop.rst | 122 +
.../linux_tv/media/v4l/vidioc-g-ctrl.rst | 114 +
.../linux_tv/media/v4l/vidioc-g-dv-timings.rst | 429 +
.../linux_tv/media/v4l/vidioc-g-edid.rst | 171 +
.../linux_tv/media/v4l/vidioc-g-enc-index.rst | 218 +
.../linux_tv/media/v4l/vidioc-g-ext-ctrls.rst | 498 +
.../linux_tv/media/v4l/vidioc-g-fbuf.rst | 509 +
.../linux_tv/media/v4l/vidioc-g-fmt.rst | 198 +
.../linux_tv/media/v4l/vidioc-g-frequency.rst | 132 +
.../linux_tv/media/v4l/vidioc-g-input.rst | 70 +
.../linux_tv/media/v4l/vidioc-g-jpegcomp.rst | 191 +
.../linux_tv/media/v4l/vidioc-g-modulator.rst | 264 +
.../linux_tv/media/v4l/vidioc-g-output.rst | 72 +
.../linux_tv/media/v4l/vidioc-g-parm.rst | 358 +
.../linux_tv/media/v4l/vidioc-g-priority.rst | 126 +
.../linux_tv/media/v4l/vidioc-g-selection.rst | 218 +
.../v4l/vidioc-g-selection_files/constraints.png | Bin 0 -> 3313 bytes
.../linux_tv/media/v4l/vidioc-g-sliced-vbi-cap.rst | 284 +
.../linux_tv/media/v4l/vidioc-g-std.rst | 76 +
.../linux_tv/media/v4l/vidioc-g-tuner.rst | 724 ++
.../linux_tv/media/v4l/vidioc-log-status.rst | 48 +
.../linux_tv/media/v4l/vidioc-overlay.rst | 62 +
.../linux_tv/media/v4l/vidioc-prepare-buf.rst | 69 +
.../linux_tv/media/v4l/vidioc-qbuf.rst | 158 +
.../linux_tv/media/v4l/vidioc-query-dv-timings.rst | 91 +
.../linux_tv/media/v4l/vidioc-querybuf.rst | 88 +
.../linux_tv/media/v4l/vidioc-querycap.rst | 442 +
.../linux_tv/media/v4l/vidioc-queryctrl.rst | 790 ++
.../linux_tv/media/v4l/vidioc-querystd.rst | 73 +
.../linux_tv/media/v4l/vidioc-reqbufs.rst | 133 +
.../linux_tv/media/v4l/vidioc-s-hw-freq-seek.rst | 187 +
.../linux_tv/media/v4l/vidioc-streamon.rst | 111 +
.../v4l/vidioc-subdev-enum-frame-interval.rst | 161 +
.../media/v4l/vidioc-subdev-enum-frame-size.rst | 170 +
.../media/v4l/vidioc-subdev-enum-mbus-code.rst | 123 +
.../linux_tv/media/v4l/vidioc-subdev-g-crop.rst | 145 +
.../linux_tv/media/v4l/vidioc-subdev-g-fmt.rst | 181 +
.../media/v4l/vidioc-subdev-g-frame-interval.rst | 131 +
.../media/v4l/vidioc-subdev-g-selection.rst | 153 +
.../linux_tv/media/v4l/vidioc-subscribe-event.rst | 144 +
.../linux_tv/media/v4l/yuv-formats.rst | 66 +
.../media_api_files/typical_media_device.pdf | Bin 0 -> 134268 bytes
.../media_api_files/typical_media_device.svg | 28 +
Documentation/books_migrated/linux_tv/net.h.rst | 70 +
Documentation/books_migrated/linux_tv/video.h.rst | 291 +
.../books_migrated/linux_tv/videodev2.h.rst | 2311 ++++
Documentation/books_migrated/lsm/conf.py | 220 +
Documentation/books_migrated/lsm/index.rst | 212 +
.../books_migrated/mtdnand/basicboarddriver.rst | 228 +
.../mtdnand/boarddriversadvanced.rst | 900 ++
Documentation/books_migrated/mtdnand/bugs.rst | 18 +
Documentation/books_migrated/mtdnand/conf.py | 220 +
Documentation/books_migrated/mtdnand/credits.rst | 31 +
Documentation/books_migrated/mtdnand/defines.rst | 159 +
Documentation/books_migrated/mtdnand/dochints.rst | 94 +
.../books_migrated/mtdnand/filesystems.rst | 33 +
Documentation/books_migrated/mtdnand/index.rst | 65 +
.../books_migrated/mtdnand/intfunctions.rst | 34 +
Documentation/books_migrated/mtdnand/intro.rst | 23 +
.../books_migrated/mtdnand/pubfunctions.rst | 38 +
Documentation/books_migrated/mtdnand/structs.rst | 29 +
Documentation/books_migrated/mtdnand/tools.rst | 28 +
Documentation/books_migrated/networking/conf.py | 220 +
Documentation/books_migrated/networking/index.rst | 51 +
.../books_migrated/networking/netcore.rst | 177 +
Documentation/books_migrated/networking/netdev.rst | 81 +
Documentation/books_migrated/rapidio/bugs.rst | 34 +
Documentation/books_migrated/rapidio/conf.py | 220 +
Documentation/books_migrated/rapidio/credits.rst | 29 +
Documentation/books_migrated/rapidio/drivers.rst | 43 +
Documentation/books_migrated/rapidio/index.rst | 58 +
Documentation/books_migrated/rapidio/internals.rst | 92 +
Documentation/books_migrated/rapidio/intro.rst | 26 +
Documentation/books_migrated/regulator/api.rst | 42 +
Documentation/books_migrated/regulator/conf.py | 219 +
.../books_migrated/regulator/consumer.rst | 78 +
Documentation/books_migrated/regulator/driver.rst | 27 +
Documentation/books_migrated/regulator/index.rst | 63 +
Documentation/books_migrated/regulator/intro.rst | 57 +
Documentation/books_migrated/regulator/machine.rst | 52 +
Documentation/books_migrated/s390-drivers/ccw.rst | 92 +
.../books_migrated/s390-drivers/ccwgroup.rst | 40 +
Documentation/books_migrated/s390-drivers/conf.py | 220 +
.../s390-drivers/genericinterfaces.rst | 28 +
.../books_migrated/s390-drivers/index.rst | 58 +
.../books_migrated/s390-drivers/intro.rst | 34 +
Documentation/books_migrated/scsi/conf.py | 220 +
Documentation/books_migrated/scsi/index.rst | 52 +
Documentation/books_migrated/scsi/intro.rst | 65 +
Documentation/books_migrated/scsi/lower_layer.rst | 58 +
Documentation/books_migrated/scsi/mid_layer.rst | 350 +
Documentation/books_migrated/scsi/upper_layer.rst | 59 +
Documentation/books_migrated/sh/busses.rst | 40 +
Documentation/books_migrated/sh/conf.py | 220 +
Documentation/books_migrated/sh/index.rst | 60 +
Documentation/books_migrated/sh/mach.rst | 40 +
Documentation/books_migrated/sh/mm.rst | 57 +
Documentation/books_migrated/tracepoint/block.rst | 23 +
Documentation/books_migrated/tracepoint/conf.py | 220 +
Documentation/books_migrated/tracepoint/index.rst | 60 +
Documentation/books_migrated/tracepoint/intro.rst | 38 +
Documentation/books_migrated/tracepoint/irq.rst | 23 +
Documentation/books_migrated/tracepoint/signal.rst | 23 +
.../books_migrated/tracepoint/workqueue.rst | 23 +
Documentation/books_migrated/uio-howto/about.rst | 168 +
.../books_migrated/uio-howto/aboutthisdoc.rst | 76 +
Documentation/books_migrated/uio-howto/conf.py | 219 +
.../uio-howto/custom_kernel_module.rst | 270 +
Documentation/books_migrated/uio-howto/index.rst | 102 +
.../books_migrated/uio-howto/uio_pci_generic.rst | 180 +
.../books_migrated/uio-howto/userspace_driver.rst | 95 +
Documentation/books_migrated/usb/conf.py | 220 +
Documentation/books_migrated/usb/hcd.rst | 55 +
Documentation/books_migrated/usb/host.rst | 80 +
Documentation/books_migrated/usb/hostside.rst | 28 +
Documentation/books_migrated/usb/index.rst | 56 +
Documentation/books_migrated/usb/intro.rst | 56 +
Documentation/books_migrated/usb/types.rst | 27 +
Documentation/books_migrated/usb/usbcore.rst | 67 +
Documentation/books_migrated/usb/usbfs.rst | 598 +
Documentation/books_migrated/w1/conf.py | 220 +
Documentation/books_migrated/w1/index.rst | 46 +
Documentation/books_migrated/w1/w1_internal.rst | 120 +
.../writing-an-alsa-driver/acknowledgments.rst | 24 +
.../writing-an-alsa-driver/api-ac97.rst | 255 +
.../writing-an-alsa-driver/basic-flow.rst | 394 +
.../writing-an-alsa-driver/buffer-and-memory.rst | 257 +
.../writing-an-alsa-driver/card-management.rst | 221 +
.../books_migrated/writing-an-alsa-driver/conf.py | 220 +
.../writing-an-alsa-driver/control-interface.rst | 454 +
.../writing-an-alsa-driver/file-tree.rst | 260 +
.../how-to-put-your-driver.rst | 125 +
.../writing-an-alsa-driver/index.rst | 96 +
.../writing-an-alsa-driver/midi-interface.rst | 129 +
.../writing-an-alsa-driver/misc-devices.rst | 183 +
.../writing-an-alsa-driver/module-parameters.rst | 65 +
.../writing-an-alsa-driver/pci-resource.rst | 459 +
.../writing-an-alsa-driver/pcm-interface.rst | 1319 +++
.../writing-an-alsa-driver/power-management.rst | 233 +
.../writing-an-alsa-driver/proc-interface.rst | 137 +
.../writing-an-alsa-driver/rawmidi-interface.rst | 267 +
.../writing-an-alsa-driver/useful-functions.rst | 84 +
.../writing_musb_glue_layer/acknowledgements.rst | 23 +
.../writing_musb_glue_layer/conclusion.rst | 25 +
.../books_migrated/writing_musb_glue_layer/conf.py | 219 +
.../device-platform-data.rst | 164 +
.../writing_musb_glue_layer/device-quirks.rst | 130 +
.../writing_musb_glue_layer/handling-irqs.rst | 96 +
.../writing_musb_glue_layer/index.rst | 61 +
.../writing_musb_glue_layer/introduction.rst | 34 +
.../writing_musb_glue_layer/linux-musb-basics.rst | 333 +
.../writing_musb_glue_layer/resources.rst | 33 +
.../writing_usb_driver/Conclusion.rst | 22 +
.../books_migrated/writing_usb_driver/basics.rst | 116 +
.../books_migrated/writing_usb_driver/conf.py | 220 +
.../books_migrated/writing_usb_driver/device.rst | 180 +
.../books_migrated/writing_usb_driver/index.rst | 63 +
.../books_migrated/writing_usb_driver/intro.rst | 42 +
.../books_migrated/writing_usb_driver/iso.rst | 24 +
.../writing_usb_driver/resources.rst | 33 +
.../z8530book/Attaching_Network_Interfaces.rst | 39 +
.../Configuring_And_Activating_The_Port.rst | 81 +
.../books_migrated/z8530book/Driver_Modes.rst | 39 +
.../z8530book/Network_Layer_Functions.rst | 34 +
.../z8530book/Porting_The_Z8530_Driver.rst | 28 +
.../z8530book/Using_the_Z85230_driver.rst | 69 +
Documentation/books_migrated/z8530book/bugs.rst | 26 +
Documentation/books_migrated/z8530book/conf.py | 220 +
Documentation/books_migrated/z8530book/index.rst | 64 +
.../books_migrated/z8530book/intfunctions.rst | 23 +
Documentation/books_migrated/z8530book/intro.rst | 26 +
.../books_migrated/z8530book/pubfunctions.rst | 23 +
Documentation/conf.py | 399 +-
Documentation/index.rst | 70 +-
.../kernel-doc-HOWTO/all-in-a-tumble-debug.rst | 16 +
.../kernel-doc-HOWTO/all-in-a-tumble-src.rst | 14 +
Documentation/kernel-doc-HOWTO/all-in-a-tumble.c | 61 +
Documentation/kernel-doc-HOWTO/all-in-a-tumble.h | 334 +
Documentation/kernel-doc-HOWTO/all-in-a-tumble.rst | 13 +
Documentation/kernel-doc-HOWTO/conf.py | 217 +
Documentation/kernel-doc-HOWTO/csv_table.txt | 6 +
.../kernel-doc-HOWTO/dbxml2rst_migration.rst | 46 +
Documentation/kernel-doc-HOWTO/index.rst | 61 +
.../kernel-doc-HOWTO/kernel-doc-components.rst | 45 +
.../kernel-doc-HOWTO/kernel-doc-directive.rst | 238 +
.../kernel-doc-HOWTO/kernel-doc-examples.rst | 19 +
.../kernel-doc-HOWTO/kernel-doc-intro.rst | 110 +
.../kernel-doc-HOWTO/kernel-doc-syntax.rst | 251 +
.../kernel-doc-HOWTO/kernel-doc-tests.rst | 131 +
.../kernel-doc-HOWTO/reST-kernel-doc-mode.rst | 111 +
Documentation/kernel-doc-HOWTO/refs.txt | 17 +
Documentation/kernel-doc-HOWTO/table-markup.rst | 502 +
.../kernel-doc-HOWTO/vintage-kernel-doc-mode.rst | 112 +
Documentation/kernel-documentation.rst | 562 -
Documentation/reST-nano-HOWTO.rst | 192 +
Documentation/sphinx-static/theme_overrides.css | 77 +
Documentation/template-book/conf.py | 220 +
Documentation/template-book/get-started.rst | 78 +
Documentation/template-book/index.rst | 33 +
Documentation/template-book/licence.rst | 22 +
Documentation/template-book/refs.rst | 16 +
Documentation/template-book/refs.txt | 17 +
Makefile | 12 +-
scripts/site-python/.gitignore | 1 +
scripts/site-python/README | 14 +
scripts/site-python/linuxdoc/__init__.py | 8 +
scripts/site-python/linuxdoc/kernel_doc.py | 2772 +++++
scripts/site-python/linuxdoc/manKernelDoc.py | 405 +
scripts/site-python/linuxdoc/rstFlatTable.py | 365 +
scripts/site-python/linuxdoc/rstKernelDoc.py | 542 +
706 files changed, 123369 insertions(+), 752 deletions(-)
create mode 100644 Documentation/Makefile.reST
create mode 100644 Documentation/article_refs.txt
create mode 100644 Documentation/books_migrated/80211/AP.rst
create mode 100644 Documentation/books_migrated/80211/advanced.rst
create mode 100644 Documentation/books_migrated/80211/aggregation-internals.rst
create mode 100644 Documentation/books_migrated/80211/aggregation.rst
create mode 100644 Documentation/books_migrated/80211/basics.rst
create mode 100644 Documentation/books_migrated/80211/beacon-filter.rst
create mode 100644 Documentation/books_migrated/80211/cfg80211-developers-guide-000-001.rst
create mode 100644 Documentation/books_migrated/80211/cfg80211-developers-guide-000-002.rst
create mode 100644 Documentation/books_migrated/80211/cfg80211-developers-guide-000-003.rst
create mode 100644 Documentation/books_migrated/80211/cfg80211-developers-guide-000-004.rst
create mode 100644 Documentation/books_migrated/80211/cfg80211-developers-guide-000-005.rst
create mode 100644 Documentation/books_migrated/80211/cfg80211-developers-guide-000-006.rst
create mode 100644 Documentation/books_migrated/80211/cfg80211-developers-guide-000-007.rst
create mode 100644 Documentation/books_migrated/80211/cfg80211-developers-guide-000-008.rst
create mode 100644 Documentation/books_migrated/80211/cfg80211-developers-guide.rst
create mode 100644 Documentation/books_migrated/80211/conf.py
create mode 100644 Documentation/books_migrated/80211/filters.rst
create mode 100644 Documentation/books_migrated/80211/hardware-crypto-offload.rst
create mode 100644 Documentation/books_migrated/80211/hardware-scan-offload.rst
create mode 100644 Documentation/books_migrated/80211/iface-handling.rst
create mode 100644 Documentation/books_migrated/80211/index.rst
create mode 100644 Documentation/books_migrated/80211/internal.rst
create mode 100644 Documentation/books_migrated/80211/key-handling.rst
create mode 100644 Documentation/books_migrated/80211/led-support.rst
create mode 100644 Documentation/books_migrated/80211/mac80211-developers-guide-000-003.rst
create mode 100644 Documentation/books_migrated/80211/mac80211-developers-guide.rst
create mode 100644 Documentation/books_migrated/80211/multi-iface.rst
create mode 100644 Documentation/books_migrated/80211/phy-handling.rst
create mode 100644 Documentation/books_migrated/80211/powersave.rst
create mode 100644 Documentation/books_migrated/80211/qos.rst
create mode 100644 Documentation/books_migrated/80211/rate-control.rst
create mode 100644 Documentation/books_migrated/80211/ratecontrol-api.rst
create mode 100644 Documentation/books_migrated/80211/rx-processing.rst
create mode 100644 Documentation/books_migrated/80211/rx-tx.rst
create mode 100644 Documentation/books_migrated/80211/smps.rst
create mode 100644 Documentation/books_migrated/80211/sta-info.rst
create mode 100644 Documentation/books_migrated/80211/station-handling.rst
create mode 100644 Documentation/books_migrated/80211/synchronisation.rst
create mode 100644 Documentation/books_migrated/80211/tx-processing.rst
create mode 100644 Documentation/books_migrated/80211/workqueue.rst
create mode 100644 Documentation/books_migrated/README.txt
create mode 100644 Documentation/books_migrated/alsa-driver-api/conf.py
create mode 100644 Documentation/books_migrated/alsa-driver-api/index-003-002.rst
create mode 100644 Documentation/books_migrated/alsa-driver-api/index-003-003.rst
create mode 100644 Documentation/books_migrated/alsa-driver-api/index-003-004.rst
create mode 100644 Documentation/books_migrated/alsa-driver-api/index-003-005.rst
create mode 100644 Documentation/books_migrated/alsa-driver-api/index-003-006.rst
create mode 100644 Documentation/books_migrated/alsa-driver-api/index-003-007.rst
create mode 100644 Documentation/books_migrated/alsa-driver-api/index-003-008.rst
create mode 100644 Documentation/books_migrated/alsa-driver-api/index-003-009.rst
create mode 100644 Documentation/books_migrated/alsa-driver-api/index.rst
create mode 100644 Documentation/books_migrated/crypto-API/API.rst
create mode 100644 Documentation/books_migrated/crypto-API/Architecture.rst
create mode 100644 Documentation/books_migrated/crypto-API/Code.rst
create mode 100644 Documentation/books_migrated/crypto-API/Development.rst
create mode 100644 Documentation/books_migrated/crypto-API/Intro.rst
create mode 100644 Documentation/books_migrated/crypto-API/User.rst
create mode 100644 Documentation/books_migrated/crypto-API/conf.py
create mode 100644 Documentation/books_migrated/crypto-API/index.rst
create mode 100644 Documentation/books_migrated/debugobjects/bugs.rst
create mode 100644 Documentation/books_migrated/debugobjects/conf.py
create mode 100644 Documentation/books_migrated/debugobjects/debugfunctions.rst
create mode 100644 Documentation/books_migrated/debugobjects/fixupfunctions.rst
create mode 100644 Documentation/books_migrated/debugobjects/howto.rst
create mode 100644 Documentation/books_migrated/debugobjects/index.rst
create mode 100644 Documentation/books_migrated/debugobjects/intro.rst
create mode 100644 Documentation/books_migrated/device-drivers/Basics.rst
create mode 100644 Documentation/books_migrated/device-drivers/conf.py
create mode 100644 Documentation/books_migrated/device-drivers/devdrivers.rst
create mode 100644 Documentation/books_migrated/device-drivers/fbdev.rst
create mode 100644 Documentation/books_migrated/device-drivers/hsi.rst
create mode 100644 Documentation/books_migrated/device-drivers/i2c.rst
create mode 100644 Documentation/books_migrated/device-drivers/index.rst
create mode 100644 Documentation/books_migrated/device-drivers/input_subsystem.rst
create mode 100644 Documentation/books_migrated/device-drivers/mediadev.rst
create mode 100644 Documentation/books_migrated/device-drivers/message_devices.rst
create mode 100644 Documentation/books_migrated/device-drivers/parportdev.rst
create mode 100644 Documentation/books_migrated/device-drivers/pwm.rst
create mode 100644 Documentation/books_migrated/device-drivers/snddev.rst
create mode 100644 Documentation/books_migrated/device-drivers/spi.rst
create mode 100644 Documentation/books_migrated/device-drivers/uart16x50.rst
create mode 100644 Documentation/books_migrated/deviceiobook/bugs.rst
create mode 100644 Documentation/books_migrated/deviceiobook/conf.py
create mode 100644 Documentation/books_migrated/deviceiobook/index.rst
create mode 100644 Documentation/books_migrated/deviceiobook/intro.rst
create mode 100644 Documentation/books_migrated/deviceiobook/mmio.rst
create mode 100644 Documentation/books_migrated/deviceiobook/port_space_accesses.rst
create mode 100644 Documentation/books_migrated/deviceiobook/pubfunctions.rst
create mode 100644 Documentation/books_migrated/filesystems/LinuxJDBAPI.rst
create mode 100644 Documentation/books_migrated/filesystems/conf.py
create mode 100644 Documentation/books_migrated/filesystems/debugfs.rst
create mode 100644 Documentation/books_migrated/filesystems/fs_events.rst
create mode 100644 Documentation/books_migrated/filesystems/index.rst
create mode 100644 Documentation/books_migrated/filesystems/pipes.rst
create mode 100644 Documentation/books_migrated/filesystems/proc.rst
create mode 100644 Documentation/books_migrated/filesystems/splice.rst
create mode 100644 Documentation/books_migrated/filesystems/sysfs.rst
create mode 100644 Documentation/books_migrated/filesystems/vfs.rst
create mode 100644 Documentation/books_migrated/gadget/api.rst
create mode 100644 Documentation/books_migrated/gadget/conf.py
create mode 100644 Documentation/books_migrated/gadget/controllers.rst
create mode 100644 Documentation/books_migrated/gadget/gadget.rst
create mode 100644 Documentation/books_migrated/gadget/index.rst
create mode 100644 Documentation/books_migrated/gadget/intro.rst
create mode 100644 Documentation/books_migrated/gadget/otg.rst
create mode 100644 Documentation/books_migrated/gadget/structure.rst
create mode 100644 Documentation/books_migrated/genericirq/Abstraction.rst
create mode 100644 Documentation/books_migrated/genericirq/bugs.rst
create mode 100644 Documentation/books_migrated/genericirq/conf.py
create mode 100644 Documentation/books_migrated/genericirq/credits.rst
create mode 100644 Documentation/books_migrated/genericirq/doirq.rst
create mode 100644 Documentation/books_migrated/genericirq/genericchip.rst
create mode 100644 Documentation/books_migrated/genericirq/index.rst
create mode 100644 Documentation/books_migrated/genericirq/intfunctions.rst
create mode 100644 Documentation/books_migrated/genericirq/intro.rst
create mode 100644 Documentation/books_migrated/genericirq/locking.rst
create mode 100644 Documentation/books_migrated/genericirq/pubfunctions.rst
create mode 100644 Documentation/books_migrated/genericirq/rationale.rst
create mode 100644 Documentation/books_migrated/genericirq/structs.rst
create mode 100644 Documentation/books_migrated/gpu/api.rst
create mode 100644 Documentation/books_migrated/gpu/conf.py
create mode 100644 Documentation/books_migrated/gpu/drmCore.rst
create mode 100644 Documentation/books_migrated/gpu/drmDrivers.rst
create mode 100644 Documentation/books_migrated/gpu/drmExternals.rst
create mode 100644 Documentation/books_migrated/gpu/drmI915.rst
create mode 100644 Documentation/books_migrated/gpu/drmInternals.rst
create mode 100644 Documentation/books_migrated/gpu/drmIntroduction.rst
create mode 100644 Documentation/books_migrated/gpu/handlers.rst
create mode 100644 Documentation/books_migrated/gpu/index.rst
create mode 100644 Documentation/books_migrated/gpu/modes_of_use.rst
create mode 100644 Documentation/books_migrated/gpu/vga_switcheroo.rst
create mode 100644 Documentation/books_migrated/iio/conf.py
create mode 100644 Documentation/books_migrated/iio/iioresources.rst
create mode 100644 Documentation/books_migrated/iio/iiosubsys.rst
create mode 100644 Documentation/books_migrated/iio/index.rst
create mode 100644 Documentation/books_migrated/iio/intro.rst
create mode 100644 Documentation/books_migrated/kernel-api/accounting.rst
create mode 100644 Documentation/books_migrated/kernel-api/adt.rst
create mode 100644 Documentation/books_migrated/kernel-api/audit.rst
create mode 100644 Documentation/books_migrated/kernel-api/blkdev.rst
create mode 100644 Documentation/books_migrated/kernel-api/chrdev.rst
create mode 100644 Documentation/books_migrated/kernel-api/clk.rst
create mode 100644 Documentation/books_migrated/kernel-api/conf.py
create mode 100644 Documentation/books_migrated/kernel-api/firmware.rst
create mode 100644 Documentation/books_migrated/kernel-api/hardware.rst
create mode 100644 Documentation/books_migrated/kernel-api/index.rst
create mode 100644 Documentation/books_migrated/kernel-api/ipc.rst
create mode 100644 Documentation/books_migrated/kernel-api/kernel-lib.rst
create mode 100644 Documentation/books_migrated/kernel-api/kfifo.rst
create mode 100644 Documentation/books_migrated/kernel-api/libc.rst
create mode 100644 Documentation/books_migrated/kernel-api/miscdev.rst
create mode 100644 Documentation/books_migrated/kernel-api/mm.rst
create mode 100644 Documentation/books_migrated/kernel-api/modload.rst
create mode 100644 Documentation/books_migrated/kernel-api/relayfs.rst
create mode 100644 Documentation/books_migrated/kernel-api/security.rst
create mode 100644 Documentation/books_migrated/kernel-hacking/atomic-ops.rst
create mode 100644 Documentation/books_migrated/kernel-hacking/basic-players.rst
create mode 100644 Documentation/books_migrated/kernel-hacking/basic-rules.rst
create mode 100644 Documentation/books_migrated/kernel-hacking/cantrips.rst
create mode 100644 Documentation/books_migrated/kernel-hacking/common-routines.rst
create mode 100644 Documentation/books_migrated/kernel-hacking/conf.py
create mode 100644 Documentation/books_migrated/kernel-hacking/conventions.rst
create mode 100644 Documentation/books_migrated/kernel-hacking/credits.rst
create mode 100644 Documentation/books_migrated/kernel-hacking/deadlock-recipes.rst
create mode 100644 Documentation/books_migrated/kernel-hacking/index.rst
create mode 100644 Documentation/books_migrated/kernel-hacking/introduction.rst
create mode 100644 Documentation/books_migrated/kernel-hacking/ioctls.rst
create mode 100644 Documentation/books_migrated/kernel-hacking/queues.rst
create mode 100644 Documentation/books_migrated/kernel-hacking/submitting.rst
create mode 100644 Documentation/books_migrated/kernel-hacking/symbols.rst
create mode 100644 Documentation/books_migrated/kernel-locking/Efficiency.rst
create mode 100644 Documentation/books_migrated/kernel-locking/Examples.rst
create mode 100644 Documentation/books_migrated/kernel-locking/apiref-futex.rst
create mode 100644 Documentation/books_migrated/kernel-locking/apiref-mutex.rst
create mode 100644 Documentation/books_migrated/kernel-locking/cheatsheet.rst
create mode 100644 Documentation/books_migrated/kernel-locking/common-problems.rst
create mode 100644 Documentation/books_migrated/kernel-locking/conf.py
create mode 100644 Documentation/books_migrated/kernel-locking/hardirq-context.rst
create mode 100644 Documentation/books_migrated/kernel-locking/index.rst
create mode 100644 Documentation/books_migrated/kernel-locking/intro.rst
create mode 100644 Documentation/books_migrated/kernel-locking/locks.rst
create mode 100644 Documentation/books_migrated/kernel-locking/races.rst
create mode 100644 Documentation/books_migrated/kernel-locking/references.rst
create mode 100644 Documentation/books_migrated/kernel-locking/sleeping-things.rst
create mode 100644 Documentation/books_migrated/kernel-locking/thanks.rst
create mode 100644 Documentation/books_migrated/kernel-locking/trylock-functions.rst
create mode 100644 Documentation/books_migrated/kgdb/CommonBackEndReq.rst
create mode 100644 Documentation/books_migrated/kgdb/CompilingAKernel.rst
create mode 100644 Documentation/books_migrated/kgdb/EnableKGDB.rst
create mode 100644 Documentation/books_migrated/kgdb/Introduction.rst
create mode 100644 Documentation/books_migrated/kgdb/KGDBTestSuite.rst
create mode 100644 Documentation/books_migrated/kgdb/conf.py
create mode 100644 Documentation/books_migrated/kgdb/credits.rst
create mode 100644 Documentation/books_migrated/kgdb/index.rst
create mode 100644 Documentation/books_migrated/kgdb/kgdbKernelArgs.rst
create mode 100644 Documentation/books_migrated/kgdb/switchKdbKgdb.rst
create mode 100644 Documentation/books_migrated/kgdb/usingKDB.rst
create mode 100644 Documentation/books_migrated/libata/PiixInt.rst
create mode 100644 Documentation/books_migrated/libata/SILInt.rst
create mode 100644 Documentation/books_migrated/libata/ataExceptions.rst
create mode 100644 Documentation/books_migrated/libata/conf.py
create mode 100644 Documentation/books_migrated/libata/index.rst
create mode 100644 Documentation/books_migrated/libata/libataDriverApi.rst
create mode 100644 Documentation/books_migrated/libata/libataEH.rst
create mode 100644 Documentation/books_migrated/libata/libataExt.rst
create mode 100644 Documentation/books_migrated/libata/libataInt.rst
create mode 100644 Documentation/books_migrated/libata/libataIntroduction.rst
create mode 100644 Documentation/books_migrated/libata/libataScsiInt.rst
create mode 100644 Documentation/books_migrated/libata/libataThanks.rst
create mode 100644 Documentation/books_migrated/librs/bugs.rst
create mode 100644 Documentation/books_migrated/librs/conf.py
create mode 100644 Documentation/books_migrated/librs/credits.rst
create mode 100644 Documentation/books_migrated/librs/index.rst
create mode 100644 Documentation/books_migrated/librs/intro.rst
create mode 100644 Documentation/books_migrated/librs/pubfunctions.rst
create mode 100644 Documentation/books_migrated/librs/structs.rst
create mode 100644 Documentation/books_migrated/librs/usage.rst
create mode 100644 Documentation/books_migrated/linux_tv/audio.h.rst
create mode 100644 Documentation/books_migrated/linux_tv/ca.h.rst
create mode 100644 Documentation/books_migrated/linux_tv/conf.py
create mode 100644 Documentation/books_migrated/linux_tv/dmx.h.rst
create mode 100644 Documentation/books_migrated/linux_tv/frontend.h.rst
create mode 100644 Documentation/books_migrated/linux_tv/index.rst
create mode 100644 Documentation/books_migrated/linux_tv/media/dvb/FE_DISHNETWORK_SEND_LEGACY_CMD.rst
create mode 100644 Documentation/books_migrated/linux_tv/media/dvb/FE_GET_EVENT.rst
create mode 100644 Documentation/books_migrated/linux_tv/media/dvb/FE_GET_FRONTEND.rst
create mode 100644 Documentation/books_migrated/linux_tv/media/dvb/FE_READ_BER.rst
create mode 100644 Documentation/books_migrated/linux_tv/media/dvb/FE_READ_SIGNAL_STRENGTH.rst
create mode 100644 Documentation/books_migrated/linux_tv/media/dvb/FE_READ_SNR.rst
create mode 100644 Documentation/books_migrated/linux_tv/media/dvb/FE_READ_UNCORRECTED_BLOCKS.rst
create mode 100644 Documentation/books_migrated/linux_tv/media/dvb/FE_SET_FRONTEND.rst
create mode 100644 Documentation/books_migrated/linux_tv/media/dvb/audio.rst
create mode 100644 Documentation/books_migrated/linux_tv/media/dvb/audio_data_types.rst
create mode 100644 Documentation/books_migrated/linux_tv/media/dvb/audio_function_calls.rst
create mode 100644 Documentation/books_migrated/linux_tv/media/dvb/audio_h.rst
create mode 100644 Documentation/books_migrated/linux_tv/media/dvb/ca.rst
create mode 100644 Documentation/books_migrated/linux_tv/media/dvb/ca_data_types.rst
create mode 100644 Documentation/books_migrated/linux_tv/media/dvb/ca_function_calls.rst
create mode 100644 Documentation/books_migrated/linux_tv/media/dvb/ca_h.rst
create mode 100644 Documentation/books_migrated/linux_tv/media/dvb/demux.rst
create mode 100644 Documentation/books_migrated/linux_tv/media/dvb/dmx_fcalls.rst
create mode 100644 Documentation/books_migrated/linux_tv/media/dvb/dmx_h.rst
create mode 100644 Documentation/books_migrated/linux_tv/media/dvb/dmx_types.rst
create mode 100644 Documentation/books_migrated/linux_tv/media/dvb/dtv-fe-stats.rst
create mode 100644 Documentation/books_migrated/linux_tv/media/dvb/dtv-properties.rst
create mode 100644 Documentation/books_migrated/linux_tv/media/dvb/dtv-property.rst
create mode 100644 Documentation/books_migrated/linux_tv/media/dvb/dtv-stats.rst
create mode 100644 Documentation/books_migrated/linux_tv/media/dvb/dvb-fe-read-status.rst
create mode 100644 Documentation/books_migrated/linux_tv/media/dvb/dvb-frontend-event.rst
create mode 100644 Documentation/books_migrated/linux_tv/media/dvb/dvb-frontend-parameters.rst
create mode 100644 Documentation/books_migrated/linux_tv/media/dvb/dvbapi.rst
create mode 100644 Documentation/books_migrated/linux_tv/media/dvb/dvbproperty-006.rst
create mode 100644 Documentation/books_migrated/linux_tv/media/dvb/dvbproperty.rst
create mode 100644 Documentation/books_migrated/linux_tv/media/dvb/examples.rst
create mode 100644 Documentation/books_migrated/linux_tv/media/dvb/fe-bandwidth-t.rst
create mode 100644 Documentation/books_migrated/linux_tv/media/dvb/fe-diseqc-recv-slave-reply.rst
create mode 100644 Documentation/books_migrated/linux_tv/media/dvb/fe-diseqc-reset-overload.rst
create mode 100644 Documentation/books_migrated/linux_tv/media/dvb/fe-diseqc-send-burst.rst
create mode 100644 Documentation/books_migrated/linux_tv/media/dvb/fe-diseqc-send-master-cmd.rst
create mode 100644 Documentation/books_migrated/linux_tv/media/dvb/fe-enable-high-lnb-voltage.rst
create mode 100644 Documentation/books_migrated/linux_tv/media/dvb/fe-get-info.rst
create mode 100644 Documentation/books_migrated/linux_tv/media/dvb/fe-get-property.rst
create mode 100644 Documentation/books_migrated/linux_tv/media/dvb/fe-read-status.rst
create mode 100644 Documentation/books_migrated/linux_tv/media/dvb/fe-set-frontend-tune-mode.rst
create mode 100644 Documentation/books_migrated/linux_tv/media/dvb/fe-set-tone.rst
create mode 100644 Documentation/books_migrated/linux_tv/media/dvb/fe-set-voltage.rst
create mode 100644 Documentation/books_migrated/linux_tv/media/dvb/fe-type-t.rst
create mode 100644 Documentation/books_migrated/linux_tv/media/dvb/fe_property_parameters.rst
create mode 100644 Documentation/books_migrated/linux_tv/media/dvb/frontend-property-cable-systems.rst
create mode 100644 Documentation/books_migrated/linux_tv/media/dvb/frontend-property-satellite-systems.rst
create mode 100644 Documentation/books_migrated/linux_tv/media/dvb/frontend-property-terrestrial-systems.rst
create mode 100644 Documentation/books_migrated/linux_tv/media/dvb/frontend-stat-properties.rst
create mode 100644 Documentation/books_migrated/linux_tv/media/dvb/frontend.rst
create mode 100644 Documentation/books_migrated/linux_tv/media/dvb/frontend_f_close.rst
create mode 100644 Documentation/books_migrated/linux_tv/media/dvb/frontend_f_open.rst
create mode 100644 Documentation/books_migrated/linux_tv/media/dvb/frontend_fcalls.rst
create mode 100644 Documentation/books_migrated/linux_tv/media/dvb/frontend_h.rst
create mode 100644 Documentation/books_migrated/linux_tv/media/dvb/frontend_legacy_api.rst
create mode 100644 Documentation/books_migrated/linux_tv/media/dvb/frontend_legacy_dvbv3_api.rst
create mode 100644 Documentation/books_migrated/linux_tv/media/dvb/intro.rst
create mode 100644 Documentation/books_migrated/linux_tv/media/dvb/intro_files/dvbstb.pdf
create mode 100644 Documentation/books_migrated/linux_tv/media/dvb/intro_files/dvbstb.png
create mode 100644 Documentation/books_migrated/linux_tv/media/dvb/legacy_dvb_apis.rst
create mode 100644 Documentation/books_migrated/linux_tv/media/dvb/net.rst
create mode 100644 Documentation/books_migrated/linux_tv/media/dvb/net_h.rst
create mode 100644 Documentation/books_migrated/linux_tv/media/dvb/query-dvb-frontend-info.rst
create mode 100644 Documentation/books_migrated/linux_tv/media/dvb/video.rst
create mode 100644 Documentation/books_migrated/linux_tv/media/dvb/video_function_calls.rst
create mode 100644 Documentation/books_migrated/linux_tv/media/dvb/video_h.rst
create mode 100644 Documentation/books_migrated/linux_tv/media/dvb/video_types.rst
create mode 100644 Documentation/books_migrated/linux_tv/media/v4l/Remote_controllers_Intro.rst
create mode 100644 Documentation/books_migrated/linux_tv/media/v4l/Remote_controllers_table_change.rst
create mode 100644 Documentation/books_migrated/linux_tv/media/v4l/Remote_controllers_tables.rst
create mode 100644 Documentation/books_migrated/linux_tv/media/v4l/app-pri.rst
create mode 100644 Documentation/books_migrated/linux_tv/media/v4l/async.rst
create mode 100644 Documentation/books_migrated/linux_tv/media/v4l/audio.rst
create mode 100644 Documentation/books_migrated/linux_tv/media/v4l/biblio.rst
create mode 100644 Documentation/books_migrated/linux_tv/media/v4l/buffer.rst
create mode 100644 Documentation/books_migrated/linux_tv/media/v4l/capture-example.rst
create mode 100644 Documentation/books_migrated/linux_tv/media/v4l/capture.c.rst
create mode 100644 Documentation/books_migrated/linux_tv/media/v4l/colorspaces.rst
create mode 100644 Documentation/books_migrated/linux_tv/media/v4l/common-defs.rst
create mode 100644 Documentation/books_migrated/linux_tv/media/v4l/common.rst
create mode 100644 Documentation/books_migrated/linux_tv/media/v4l/compat.rst
create mode 100644 Documentation/books_migrated/linux_tv/media/v4l/control.rst
create mode 100644 Documentation/books_migrated/linux_tv/media/v4l/controls.rst
create mode 100644 Documentation/books_migrated/linux_tv/media/v4l/crop.rst
create mode 100644 Documentation/books_migrated/linux_tv/media/v4l/crop_files/crop.gif
create mode 100644 Documentation/books_migrated/linux_tv/media/v4l/crop_files/crop.pdf
create mode 100644 Documentation/books_migrated/linux_tv/media/v4l/depth-formats.rst
create mode 100644 Documentation/books_migrated/linux_tv/media/v4l/dev-capture.rst
create mode 100644 Documentation/books_migrated/linux_tv/media/v4l/dev-codec.rst
create mode 100644 Documentation/books_migrated/linux_tv/media/v4l/dev-effect.rst
create mode 100644 Documentation/books_migrated/linux_tv/media/v4l/dev-event.rst
create mode 100644 Documentation/books_migrated/linux_tv/media/v4l/dev-osd.rst
create mode 100644 Documentation/books_migrated/linux_tv/media/v4l/dev-output.rst
create mode 100644 Documentation/books_migrated/linux_tv/media/v4l/dev-overlay.rst
create mode 100644 Documentation/books_migrated/linux_tv/media/v4l/dev-radio.rst
create mode 100644 Documentation/books_migrated/linux_tv/media/v4l/dev-raw-vbi.rst
create mode 100644 Documentation/books_migrated/linux_tv/media/v4l/dev-raw-vbi_files/vbi_525.gif
create mode 100644 Documentation/books_migrated/linux_tv/media/v4l/dev-raw-vbi_files/vbi_525.pdf
create mode 100644 Documentation/books_migrated/linux_tv/media/v4l/dev-raw-vbi_files/vbi_625.gif
create mode 100644 Documentation/books_migrated/linux_tv/media/v4l/dev-raw-vbi_files/vbi_625.pdf
create mode 100644 Documentation/books_migrated/linux_tv/media/v4l/dev-raw-vbi_files/vbi_hsync.gif
create mode 100644 Documentation/books_migrated/linux_tv/media/v4l/dev-raw-vbi_files/vbi_hsync.pdf
create mode 100644 Documentation/books_migrated/linux_tv/media/v4l/dev-rds.rst
create mode 100644 Documentation/books_migrated/linux_tv/media/v4l/dev-sdr.rst
create mode 100644 Documentation/books_migrated/linux_tv/media/v4l/dev-sliced-vbi.rst
create mode 100644 Documentation/books_migrated/linux_tv/media/v4l/dev-subdev.rst
create mode 100644 Documentation/books_migrated/linux_tv/media/v4l/dev-subdev_files/pipeline.pdf
create mode 100644 Documentation/books_migrated/linux_tv/media/v4l/dev-subdev_files/pipeline.png
create mode 100644 Documentation/books_migrated/linux_tv/media/v4l/dev-subdev_files/subdev-image-processing-crop.pdf
create mode 100644 Documentation/books_migrated/linux_tv/media/v4l/dev-subdev_files/subdev-image-processing-crop.svg
create mode 100644 Documentation/books_migrated/linux_tv/media/v4l/dev-subdev_files/subdev-image-processing-full.pdf
create mode 100644 Documentation/books_migrated/linux_tv/media/v4l/dev-subdev_files/subdev-image-processing-full.svg
create mode 100644 Documentation/books_migrated/linux_tv/media/v4l/dev-subdev_files/subdev-image-processing-scaling-multi-source.pdf
create mode 100644 Documentation/books_migrated/linux_tv/media/v4l/dev-subdev_files/subdev-image-processing-scaling-multi-source.svg
create mode 100644 Documentation/books_migrated/linux_tv/media/v4l/dev-teletext.rst
create mode 100644 Documentation/books_migrated/linux_tv/media/v4l/devices.rst
create mode 100644 Documentation/books_migrated/linux_tv/media/v4l/diff-v4l.rst
create mode 100644 Documentation/books_migrated/linux_tv/media/v4l/dmabuf.rst
create mode 100644 Documentation/books_migrated/linux_tv/media/v4l/driver.rst
create mode 100644 Documentation/books_migrated/linux_tv/media/v4l/dv-timings.rst
create mode 100644 Documentation/books_migrated/linux_tv/media/v4l/extended-controls.rst
create mode 100644 Documentation/books_migrated/linux_tv/media/v4l/fdl-appendix.rst
create mode 100644 Documentation/books_migrated/linux_tv/media/v4l/field-order.rst
create mode 100644 Documentation/books_migrated/linux_tv/media/v4l/field-order_files/fieldseq_bt.gif
create mode 100644 Documentation/books_migrated/linux_tv/media/v4l/field-order_files/fieldseq_bt.pdf
create mode 100644 Documentation/books_migrated/linux_tv/media/v4l/field-order_files/fieldseq_tb.gif
create mode 100644 Documentation/books_migrated/linux_tv/media/v4l/field-order_files/fieldseq_tb.pdf
create mode 100644 Documentation/books_migrated/linux_tv/media/v4l/format.rst
create mode 100644 Documentation/books_migrated/linux_tv/media/v4l/func-close.rst
create mode 100644 Documentation/books_migrated/linux_tv/media/v4l/func-ioctl.rst
create mode 100644 Documentation/books_migrated/linux_tv/media/v4l/func-mmap.rst
create mode 100644 Documentation/books_migrated/linux_tv/media/v4l/func-munmap.rst
create mode 100644 Documentation/books_migrated/linux_tv/media/v4l/func-open.rst
create mode 100644 Documentation/books_migrated/linux_tv/media/v4l/func-poll.rst
create mode 100644 Documentation/books_migrated/linux_tv/media/v4l/func-read.rst
create mode 100644 Documentation/books_migrated/linux_tv/media/v4l/func-select.rst
create mode 100644 Documentation/books_migrated/linux_tv/media/v4l/func-write.rst
create mode 100644 Documentation/books_migrated/linux_tv/media/v4l/gen-errors.rst
create mode 100644 Documentation/books_migrated/linux_tv/media/v4l/hist-v4l2.rst
create mode 100644 Documentation/books_migrated/linux_tv/media/v4l/io.rst
create mode 100644 Documentation/books_migrated/linux_tv/media/v4l/keytable.c.rst
create mode 100644 Documentation/books_migrated/linux_tv/media/v4l/libv4l-introduction.rst
create mode 100644 Documentation/books_migrated/linux_tv/media/v4l/libv4l.rst
create mode 100644 Documentation/books_migrated/linux_tv/media/v4l/lirc_dev_intro.rst
create mode 100644 Documentation/books_migrated/linux_tv/media/v4l/lirc_device_interface.rst
create mode 100644 Documentation/books_migrated/linux_tv/media/v4l/lirc_ioctl.rst
create mode 100644 Documentation/books_migrated/linux_tv/media/v4l/lirc_read.rst
create mode 100644 Documentation/books_migrated/linux_tv/media/v4l/lirc_write.rst
create mode 100644 Documentation/books_migrated/linux_tv/media/v4l/media-controller-intro.rst
create mode 100644 Documentation/books_migrated/linux_tv/media/v4l/media-controller-model.rst
create mode 100644 Documentation/books_migrated/linux_tv/media/v4l/media-controller.rst
create mode 100644 Documentation/books_migrated/linux_tv/media/v4l/media-func-close.rst
create mode 100644 Documentation/books_migrated/linux_tv/media/v4l/media-func-ioctl.rst
create mode 100644 Documentation/books_migrated/linux_tv/media/v4l/media-func-open.rst
create mode 100644 Documentation/books_migrated/linux_tv/media/v4l/media-ioc-device-info.rst
create mode 100644 Documentation/books_migrated/linux_tv/media/v4l/media-ioc-enum-entities.rst
create mode 100644 Documentation/books_migrated/linux_tv/media/v4l/media-ioc-enum-links.rst
create mode 100644 Documentation/books_migrated/linux_tv/media/v4l/media-ioc-g-topology.rst
create mode 100644 Documentation/books_migrated/linux_tv/media/v4l/media-ioc-setup-link.rst
create mode 100644 Documentation/books_migrated/linux_tv/media/v4l/media-types.rst
create mode 100644 Documentation/books_migrated/linux_tv/media/v4l/mmap.rst
create mode 100644 Documentation/books_migrated/linux_tv/media/v4l/open.rst
create mode 100644 Documentation/books_migrated/linux_tv/media/v4l/pixfmt-002.rst
create mode 100644 Documentation/books_migrated/linux_tv/media/v4l/pixfmt-003.rst
create mode 100644 Documentation/books_migrated/linux_tv/media/v4l/pixfmt-004.rst
create mode 100644 Documentation/books_migrated/linux_tv/media/v4l/pixfmt-006.rst
create mode 100644 Documentation/books_migrated/linux_tv/media/v4l/pixfmt-007.rst
create mode 100644 Documentation/books_migrated/linux_tv/media/v4l/pixfmt-008.rst
create mode 100644 Documentation/books_migrated/linux_tv/media/v4l/pixfmt-013.rst
create mode 100644 Documentation/books_migrated/linux_tv/media/v4l/pixfmt-grey.rst
create mode 100644 Documentation/books_migrated/linux_tv/media/v4l/pixfmt-indexed.rst
create mode 100644 Documentation/books_migrated/linux_tv/media/v4l/pixfmt-m420.rst
create mode 100644 Documentation/books_migrated/linux_tv/media/v4l/pixfmt-nv12.rst
create mode 100644 Documentation/books_migrated/linux_tv/media/v4l/pixfmt-nv12m.rst
create mode 100644 Documentation/books_migrated/linux_tv/media/v4l/pixfmt-nv12mt.rst
create mode 100644 Documentation/books_migrated/linux_tv/media/v4l/pixfmt-nv12mt_files/nv12mt.gif
create mode 100644 Documentation/books_migrated/linux_tv/media/v4l/pixfmt-nv12mt_files/nv12mt_example.gif
create mode 100644 Documentation/books_migrated/linux_tv/media/v4l/pixfmt-nv16.rst
create mode 100644 Documentation/books_migrated/linux_tv/media/v4l/pixfmt-nv16m.rst
create mode 100644 Documentation/books_migrated/linux_tv/media/v4l/pixfmt-nv24.rst
create mode 100644 Documentation/books_migrated/linux_tv/media/v4l/pixfmt-packed-rgb.rst
create mode 100644 Documentation/books_migrated/linux_tv/media/v4l/pixfmt-packed-yuv.rst
create mode 100644 Documentation/books_migrated/linux_tv/media/v4l/pixfmt-reserved.rst
create mode 100644 Documentation/books_migrated/linux_tv/media/v4l/pixfmt-rgb.rst
create mode 100644 Documentation/books_migrated/linux_tv/media/v4l/pixfmt-sbggr16.rst
create mode 100644 Documentation/books_migrated/linux_tv/media/v4l/pixfmt-sbggr8.rst
create mode 100644 Documentation/books_migrated/linux_tv/media/v4l/pixfmt-sdr-cs08.rst
create mode 100644 Documentation/books_migrated/linux_tv/media/v4l/pixfmt-sdr-cs14le.rst
create mode 100644 Documentation/books_migrated/linux_tv/media/v4l/pixfmt-sdr-cu08.rst
create mode 100644 Documentation/books_migrated/linux_tv/media/v4l/pixfmt-sdr-cu16le.rst
create mode 100644 Documentation/books_migrated/linux_tv/media/v4l/pixfmt-sdr-ru12le.rst
create mode 100644 Documentation/books_migrated/linux_tv/media/v4l/pixfmt-sgbrg8.rst
create mode 100644 Documentation/books_migrated/linux_tv/media/v4l/pixfmt-sgrbg8.rst
create mode 100644 Documentation/books_migrated/linux_tv/media/v4l/pixfmt-srggb10.rst
create mode 100644 Documentation/books_migrated/linux_tv/media/v4l/pixfmt-srggb10alaw8.rst
create mode 100644 Documentation/books_migrated/linux_tv/media/v4l/pixfmt-srggb10dpcm8.rst
create mode 100644 Documentation/books_migrated/linux_tv/media/v4l/pixfmt-srggb10p.rst
create mode 100644 Documentation/books_migrated/linux_tv/media/v4l/pixfmt-srggb12.rst
create mode 100644 Documentation/books_migrated/linux_tv/media/v4l/pixfmt-srggb8.rst
create mode 100644 Documentation/books_migrated/linux_tv/media/v4l/pixfmt-uv8.rst
create mode 100644 Documentation/books_migrated/linux_tv/media/v4l/pixfmt-uyvy.rst
create mode 100644 Documentation/books_migrated/linux_tv/media/v4l/pixfmt-vyuy.rst
create mode 100644 Documentation/books_migrated/linux_tv/media/v4l/pixfmt-y10.rst
create mode 100644 Documentation/books_migrated/linux_tv/media/v4l/pixfmt-y10b.rst
create mode 100644 Documentation/books_migrated/linux_tv/media/v4l/pixfmt-y12.rst
create mode 100644 Documentation/books_migrated/linux_tv/media/v4l/pixfmt-y12i.rst
create mode 100644 Documentation/books_migrated/linux_tv/media/v4l/pixfmt-y16-be.rst
create mode 100644 Documentation/books_migrated/linux_tv/media/v4l/pixfmt-y16.rst
create mode 100644 Documentation/books_migrated/linux_tv/media/v4l/pixfmt-y41p.rst
create mode 100644 Documentation/books_migrated/linux_tv/media/v4l/pixfmt-y8i.rst
create mode 100644 Documentation/books_migrated/linux_tv/media/v4l/pixfmt-yuv410.rst
create mode 100644 Documentation/books_migrated/linux_tv/media/v4l/pixfmt-yuv411p.rst
create mode 100644 Documentation/books_migrated/linux_tv/media/v4l/pixfmt-yuv420.rst
create mode 100644 Documentation/books_migrated/linux_tv/media/v4l/pixfmt-yuv420m.rst
create mode 100644 Documentation/books_migrated/linux_tv/media/v4l/pixfmt-yuv422m.rst
create mode 100644 Documentation/books_migrated/linux_tv/media/v4l/pixfmt-yuv422p.rst
create mode 100644 Documentation/books_migrated/linux_tv/media/v4l/pixfmt-yuv444m.rst
create mode 100644 Documentation/books_migrated/linux_tv/media/v4l/pixfmt-yuyv.rst
create mode 100644 Documentation/books_migrated/linux_tv/media/v4l/pixfmt-yvyu.rst
create mode 100644 Documentation/books_migrated/linux_tv/media/v4l/pixfmt-z16.rst
create mode 100644 Documentation/books_migrated/linux_tv/media/v4l/pixfmt.rst
create mode 100644 Documentation/books_migrated/linux_tv/media/v4l/planar-apis.rst
create mode 100644 Documentation/books_migrated/linux_tv/media/v4l/querycap.rst
create mode 100644 Documentation/books_migrated/linux_tv/media/v4l/remote_controllers.rst
create mode 100644 Documentation/books_migrated/linux_tv/media/v4l/remote_controllers_sysfs_nodes.rst
create mode 100644 Documentation/books_migrated/linux_tv/media/v4l/rw.rst
create mode 100644 Documentation/books_migrated/linux_tv/media/v4l/sdr-formats.rst
create mode 100644 Documentation/books_migrated/linux_tv/media/v4l/selection-api-002.rst
create mode 100644 Documentation/books_migrated/linux_tv/media/v4l/selection-api-003.rst
create mode 100644 Documentation/books_migrated/linux_tv/media/v4l/selection-api-003_files/selection.png
create mode 100644 Documentation/books_migrated/linux_tv/media/v4l/selection-api-004.rst
create mode 100644 Documentation/books_migrated/linux_tv/media/v4l/selection-api-005.rst
create mode 100644 Documentation/books_migrated/linux_tv/media/v4l/selection-api-006.rst
create mode 100644 Documentation/books_migrated/linux_tv/media/v4l/selection-api.rst
create mode 100644 Documentation/books_migrated/linux_tv/media/v4l/selections-common.rst
create mode 100644 Documentation/books_migrated/linux_tv/media/v4l/standard.rst
create mode 100644 Documentation/books_migrated/linux_tv/media/v4l/streaming-par.rst
create mode 100644 Documentation/books_migrated/linux_tv/media/v4l/subdev-formats.rst
create mode 100644 Documentation/books_migrated/linux_tv/media/v4l/subdev-formats_files/bayer.png
create mode 100644 Documentation/books_migrated/linux_tv/media/v4l/tuner.rst
create mode 100644 Documentation/books_migrated/linux_tv/media/v4l/user-func.rst
create mode 100644 Documentation/books_migrated/linux_tv/media/v4l/userp.rst
create mode 100644 Documentation/books_migrated/linux_tv/media/v4l/v4l2-selection-flags.rst
create mode 100644 Documentation/books_migrated/linux_tv/media/v4l/v4l2-selection-targets.rst
create mode 100644 Documentation/books_migrated/linux_tv/media/v4l/v4l2.rst
create mode 100644 Documentation/books_migrated/linux_tv/media/v4l/v4l2grab-example.rst
create mode 100644 Documentation/books_migrated/linux_tv/media/v4l/v4l2grab.c.rst
create mode 100644 Documentation/books_migrated/linux_tv/media/v4l/video.rst
create mode 100644 Documentation/books_migrated/linux_tv/media/v4l/videodev.rst
create mode 100644 Documentation/books_migrated/linux_tv/media/v4l/vidioc-create-bufs.rst
create mode 100644 Documentation/books_migrated/linux_tv/media/v4l/vidioc-cropcap.rst
create mode 100644 Documentation/books_migrated/linux_tv/media/v4l/vidioc-dbg-g-chip-info.rst
create mode 100644 Documentation/books_migrated/linux_tv/media/v4l/vidioc-dbg-g-register.rst
create mode 100644 Documentation/books_migrated/linux_tv/media/v4l/vidioc-decoder-cmd.rst
create mode 100644 Documentation/books_migrated/linux_tv/media/v4l/vidioc-dqevent.rst
create mode 100644 Documentation/books_migrated/linux_tv/media/v4l/vidioc-dv-timings-cap.rst
create mode 100644 Documentation/books_migrated/linux_tv/media/v4l/vidioc-encoder-cmd.rst
create mode 100644 Documentation/books_migrated/linux_tv/media/v4l/vidioc-enum-dv-timings.rst
create mode 100644 Documentation/books_migrated/linux_tv/media/v4l/vidioc-enum-fmt.rst
create mode 100644 Documentation/books_migrated/linux_tv/media/v4l/vidioc-enum-frameintervals.rst
create mode 100644 Documentation/books_migrated/linux_tv/media/v4l/vidioc-enum-framesizes.rst
create mode 100644 Documentation/books_migrated/linux_tv/media/v4l/vidioc-enum-freq-bands.rst
create mode 100644 Documentation/books_migrated/linux_tv/media/v4l/vidioc-enumaudio.rst
create mode 100644 Documentation/books_migrated/linux_tv/media/v4l/vidioc-enumaudioout.rst
create mode 100644 Documentation/books_migrated/linux_tv/media/v4l/vidioc-enuminput.rst
create mode 100644 Documentation/books_migrated/linux_tv/media/v4l/vidioc-enumoutput.rst
create mode 100644 Documentation/books_migrated/linux_tv/media/v4l/vidioc-enumstd.rst
create mode 100644 Documentation/books_migrated/linux_tv/media/v4l/vidioc-expbuf.rst
create mode 100644 Documentation/books_migrated/linux_tv/media/v4l/vidioc-g-audio.rst
create mode 100644 Documentation/books_migrated/linux_tv/media/v4l/vidioc-g-audioout.rst
create mode 100644 Documentation/books_migrated/linux_tv/media/v4l/vidioc-g-crop.rst
create mode 100644 Documentation/books_migrated/linux_tv/media/v4l/vidioc-g-ctrl.rst
create mode 100644 Documentation/books_migrated/linux_tv/media/v4l/vidioc-g-dv-timings.rst
create mode 100644 Documentation/books_migrated/linux_tv/media/v4l/vidioc-g-edid.rst
create mode 100644 Documentation/books_migrated/linux_tv/media/v4l/vidioc-g-enc-index.rst
create mode 100644 Documentation/books_migrated/linux_tv/media/v4l/vidioc-g-ext-ctrls.rst
create mode 100644 Documentation/books_migrated/linux_tv/media/v4l/vidioc-g-fbuf.rst
create mode 100644 Documentation/books_migrated/linux_tv/media/v4l/vidioc-g-fmt.rst
create mode 100644 Documentation/books_migrated/linux_tv/media/v4l/vidioc-g-frequency.rst
create mode 100644 Documentation/books_migrated/linux_tv/media/v4l/vidioc-g-input.rst
create mode 100644 Documentation/books_migrated/linux_tv/media/v4l/vidioc-g-jpegcomp.rst
create mode 100644 Documentation/books_migrated/linux_tv/media/v4l/vidioc-g-modulator.rst
create mode 100644 Documentation/books_migrated/linux_tv/media/v4l/vidioc-g-output.rst
create mode 100644 Documentation/books_migrated/linux_tv/media/v4l/vidioc-g-parm.rst
create mode 100644 Documentation/books_migrated/linux_tv/media/v4l/vidioc-g-priority.rst
create mode 100644 Documentation/books_migrated/linux_tv/media/v4l/vidioc-g-selection.rst
create mode 100644 Documentation/books_migrated/linux_tv/media/v4l/vidioc-g-selection_files/constraints.png
create mode 100644 Documentation/books_migrated/linux_tv/media/v4l/vidioc-g-sliced-vbi-cap.rst
create mode 100644 Documentation/books_migrated/linux_tv/media/v4l/vidioc-g-std.rst
create mode 100644 Documentation/books_migrated/linux_tv/media/v4l/vidioc-g-tuner.rst
create mode 100644 Documentation/books_migrated/linux_tv/media/v4l/vidioc-log-status.rst
create mode 100644 Documentation/books_migrated/linux_tv/media/v4l/vidioc-overlay.rst
create mode 100644 Documentation/books_migrated/linux_tv/media/v4l/vidioc-prepare-buf.rst
create mode 100644 Documentation/books_migrated/linux_tv/media/v4l/vidioc-qbuf.rst
create mode 100644 Documentation/books_migrated/linux_tv/media/v4l/vidioc-query-dv-timings.rst
create mode 100644 Documentation/books_migrated/linux_tv/media/v4l/vidioc-querybuf.rst
create mode 100644 Documentation/books_migrated/linux_tv/media/v4l/vidioc-querycap.rst
create mode 100644 Documentation/books_migrated/linux_tv/media/v4l/vidioc-queryctrl.rst
create mode 100644 Documentation/books_migrated/linux_tv/media/v4l/vidioc-querystd.rst
create mode 100644 Documentation/books_migrated/linux_tv/media/v4l/vidioc-reqbufs.rst
create mode 100644 Documentation/books_migrated/linux_tv/media/v4l/vidioc-s-hw-freq-seek.rst
create mode 100644 Documentation/books_migrated/linux_tv/media/v4l/vidioc-streamon.rst
create mode 100644 Documentation/books_migrated/linux_tv/media/v4l/vidioc-subdev-enum-frame-interval.rst
create mode 100644 Documentation/books_migrated/linux_tv/media/v4l/vidioc-subdev-enum-frame-size.rst
create mode 100644 Documentation/books_migrated/linux_tv/media/v4l/vidioc-subdev-enum-mbus-code.rst
create mode 100644 Documentation/books_migrated/linux_tv/media/v4l/vidioc-subdev-g-crop.rst
create mode 100644 Documentation/books_migrated/linux_tv/media/v4l/vidioc-subdev-g-fmt.rst
create mode 100644 Documentation/books_migrated/linux_tv/media/v4l/vidioc-subdev-g-frame-interval.rst
create mode 100644 Documentation/books_migrated/linux_tv/media/v4l/vidioc-subdev-g-selection.rst
create mode 100644 Documentation/books_migrated/linux_tv/media/v4l/vidioc-subscribe-event.rst
create mode 100644 Documentation/books_migrated/linux_tv/media/v4l/yuv-formats.rst
create mode 100644 Documentation/books_migrated/linux_tv/media_api_files/typical_media_device.pdf
create mode 100644 Documentation/books_migrated/linux_tv/media_api_files/typical_media_device.svg
create mode 100644 Documentation/books_migrated/linux_tv/net.h.rst
create mode 100644 Documentation/books_migrated/linux_tv/video.h.rst
create mode 100644 Documentation/books_migrated/linux_tv/videodev2.h.rst
create mode 100644 Documentation/books_migrated/lsm/conf.py
create mode 100644 Documentation/books_migrated/lsm/index.rst
create mode 100644 Documentation/books_migrated/mtdnand/basicboarddriver.rst
create mode 100644 Documentation/books_migrated/mtdnand/boarddriversadvanced.rst
create mode 100644 Documentation/books_migrated/mtdnand/bugs.rst
create mode 100644 Documentation/books_migrated/mtdnand/conf.py
create mode 100644 Documentation/books_migrated/mtdnand/credits.rst
create mode 100644 Documentation/books_migrated/mtdnand/defines.rst
create mode 100644 Documentation/books_migrated/mtdnand/dochints.rst
create mode 100644 Documentation/books_migrated/mtdnand/filesystems.rst
create mode 100644 Documentation/books_migrated/mtdnand/index.rst
create mode 100644 Documentation/books_migrated/mtdnand/intfunctions.rst
create mode 100644 Documentation/books_migrated/mtdnand/intro.rst
create mode 100644 Documentation/books_migrated/mtdnand/pubfunctions.rst
create mode 100644 Documentation/books_migrated/mtdnand/structs.rst
create mode 100644 Documentation/books_migrated/mtdnand/tools.rst
create mode 100644 Documentation/books_migrated/networking/conf.py
create mode 100644 Documentation/books_migrated/networking/index.rst
create mode 100644 Documentation/books_migrated/networking/netcore.rst
create mode 100644 Documentation/books_migrated/networking/netdev.rst
create mode 100644 Documentation/books_migrated/rapidio/bugs.rst
create mode 100644 Documentation/books_migrated/rapidio/conf.py
create mode 100644 Documentation/books_migrated/rapidio/credits.rst
create mode 100644 Documentation/books_migrated/rapidio/drivers.rst
create mode 100644 Documentation/books_migrated/rapidio/index.rst
create mode 100644 Documentation/books_migrated/rapidio/internals.rst
create mode 100644 Documentation/books_migrated/rapidio/intro.rst
create mode 100644 Documentation/books_migrated/regulator/api.rst
create mode 100644 Documentation/books_migrated/regulator/conf.py
create mode 100644 Documentation/books_migrated/regulator/consumer.rst
create mode 100644 Documentation/books_migrated/regulator/driver.rst
create mode 100644 Documentation/books_migrated/regulator/index.rst
create mode 100644 Documentation/books_migrated/regulator/intro.rst
create mode 100644 Documentation/books_migrated/regulator/machine.rst
create mode 100644 Documentation/books_migrated/s390-drivers/ccw.rst
create mode 100644 Documentation/books_migrated/s390-drivers/ccwgroup.rst
create mode 100644 Documentation/books_migrated/s390-drivers/conf.py
create mode 100644 Documentation/books_migrated/s390-drivers/genericinterfaces.rst
create mode 100644 Documentation/books_migrated/s390-drivers/index.rst
create mode 100644 Documentation/books_migrated/s390-drivers/intro.rst
create mode 100644 Documentation/books_migrated/scsi/conf.py
create mode 100644 Documentation/books_migrated/scsi/index.rst
create mode 100644 Documentation/books_migrated/scsi/intro.rst
create mode 100644 Documentation/books_migrated/scsi/lower_layer.rst
create mode 100644 Documentation/books_migrated/scsi/mid_layer.rst
create mode 100644 Documentation/books_migrated/scsi/upper_layer.rst
create mode 100644 Documentation/books_migrated/sh/busses.rst
create mode 100644 Documentation/books_migrated/sh/conf.py
create mode 100644 Documentation/books_migrated/sh/index.rst
create mode 100644 Documentation/books_migrated/sh/mach.rst
create mode 100644 Documentation/books_migrated/sh/mm.rst
create mode 100644 Documentation/books_migrated/tracepoint/block.rst
create mode 100644 Documentation/books_migrated/tracepoint/conf.py
create mode 100644 Documentation/books_migrated/tracepoint/index.rst
create mode 100644 Documentation/books_migrated/tracepoint/intro.rst
create mode 100644 Documentation/books_migrated/tracepoint/irq.rst
create mode 100644 Documentation/books_migrated/tracepoint/signal.rst
create mode 100644 Documentation/books_migrated/tracepoint/workqueue.rst
create mode 100644 Documentation/books_migrated/uio-howto/about.rst
create mode 100644 Documentation/books_migrated/uio-howto/aboutthisdoc.rst
create mode 100644 Documentation/books_migrated/uio-howto/conf.py
create mode 100644 Documentation/books_migrated/uio-howto/custom_kernel_module.rst
create mode 100644 Documentation/books_migrated/uio-howto/index.rst
create mode 100644 Documentation/books_migrated/uio-howto/uio_pci_generic.rst
create mode 100644 Documentation/books_migrated/uio-howto/userspace_driver.rst
create mode 100644 Documentation/books_migrated/usb/conf.py
create mode 100644 Documentation/books_migrated/usb/hcd.rst
create mode 100644 Documentation/books_migrated/usb/host.rst
create mode 100644 Documentation/books_migrated/usb/hostside.rst
create mode 100644 Documentation/books_migrated/usb/index.rst
create mode 100644 Documentation/books_migrated/usb/intro.rst
create mode 100644 Documentation/books_migrated/usb/types.rst
create mode 100644 Documentation/books_migrated/usb/usbcore.rst
create mode 100644 Documentation/books_migrated/usb/usbfs.rst
create mode 100644 Documentation/books_migrated/w1/conf.py
create mode 100644 Documentation/books_migrated/w1/index.rst
create mode 100644 Documentation/books_migrated/w1/w1_internal.rst
create mode 100644 Documentation/books_migrated/writing-an-alsa-driver/acknowledgments.rst
create mode 100644 Documentation/books_migrated/writing-an-alsa-driver/api-ac97.rst
create mode 100644 Documentation/books_migrated/writing-an-alsa-driver/basic-flow.rst
create mode 100644 Documentation/books_migrated/writing-an-alsa-driver/buffer-and-memory.rst
create mode 100644 Documentation/books_migrated/writing-an-alsa-driver/card-management.rst
create mode 100644 Documentation/books_migrated/writing-an-alsa-driver/conf.py
create mode 100644 Documentation/books_migrated/writing-an-alsa-driver/control-interface.rst
create mode 100644 Documentation/books_migrated/writing-an-alsa-driver/file-tree.rst
create mode 100644 Documentation/books_migrated/writing-an-alsa-driver/how-to-put-your-driver.rst
create mode 100644 Documentation/books_migrated/writing-an-alsa-driver/index.rst
create mode 100644 Documentation/books_migrated/writing-an-alsa-driver/midi-interface.rst
create mode 100644 Documentation/books_migrated/writing-an-alsa-driver/misc-devices.rst
create mode 100644 Documentation/books_migrated/writing-an-alsa-driver/module-parameters.rst
create mode 100644 Documentation/books_migrated/writing-an-alsa-driver/pci-resource.rst
create mode 100644 Documentation/books_migrated/writing-an-alsa-driver/pcm-interface.rst
create mode 100644 Documentation/books_migrated/writing-an-alsa-driver/power-management.rst
create mode 100644 Documentation/books_migrated/writing-an-alsa-driver/proc-interface.rst
create mode 100644 Documentation/books_migrated/writing-an-alsa-driver/rawmidi-interface.rst
create mode 100644 Documentation/books_migrated/writing-an-alsa-driver/useful-functions.rst
create mode 100644 Documentation/books_migrated/writing_musb_glue_layer/acknowledgements.rst
create mode 100644 Documentation/books_migrated/writing_musb_glue_layer/conclusion.rst
create mode 100644 Documentation/books_migrated/writing_musb_glue_layer/conf.py
create mode 100644 Documentation/books_migrated/writing_musb_glue_layer/device-platform-data.rst
create mode 100644 Documentation/books_migrated/writing_musb_glue_layer/device-quirks.rst
create mode 100644 Documentation/books_migrated/writing_musb_glue_layer/handling-irqs.rst
create mode 100644 Documentation/books_migrated/writing_musb_glue_layer/index.rst
create mode 100644 Documentation/books_migrated/writing_musb_glue_layer/introduction.rst
create mode 100644 Documentation/books_migrated/writing_musb_glue_layer/linux-musb-basics.rst
create mode 100644 Documentation/books_migrated/writing_musb_glue_layer/resources.rst
create mode 100644 Documentation/books_migrated/writing_usb_driver/Conclusion.rst
create mode 100644 Documentation/books_migrated/writing_usb_driver/basics.rst
create mode 100644 Documentation/books_migrated/writing_usb_driver/conf.py
create mode 100644 Documentation/books_migrated/writing_usb_driver/device.rst
create mode 100644 Documentation/books_migrated/writing_usb_driver/index.rst
create mode 100644 Documentation/books_migrated/writing_usb_driver/intro.rst
create mode 100644 Documentation/books_migrated/writing_usb_driver/iso.rst
create mode 100644 Documentation/books_migrated/writing_usb_driver/resources.rst
create mode 100644 Documentation/books_migrated/z8530book/Attaching_Network_Interfaces.rst
create mode 100644 Documentation/books_migrated/z8530book/Configuring_And_Activating_The_Port.rst
create mode 100644 Documentation/books_migrated/z8530book/Driver_Modes.rst
create mode 100644 Documentation/books_migrated/z8530book/Network_Layer_Functions.rst
create mode 100644 Documentation/books_migrated/z8530book/Porting_The_Z8530_Driver.rst
create mode 100644 Documentation/books_migrated/z8530book/Using_the_Z85230_driver.rst
create mode 100644 Documentation/books_migrated/z8530book/bugs.rst
create mode 100644 Documentation/books_migrated/z8530book/conf.py
create mode 100644 Documentation/books_migrated/z8530book/index.rst
create mode 100644 Documentation/books_migrated/z8530book/intfunctions.rst
create mode 100644 Documentation/books_migrated/z8530book/intro.rst
create mode 100644 Documentation/books_migrated/z8530book/pubfunctions.rst
create mode 100644 Documentation/kernel-doc-HOWTO/all-in-a-tumble-debug.rst
create mode 100644 Documentation/kernel-doc-HOWTO/all-in-a-tumble-src.rst
create mode 100644 Documentation/kernel-doc-HOWTO/all-in-a-tumble.c
create mode 100644 Documentation/kernel-doc-HOWTO/all-in-a-tumble.h
create mode 100644 Documentation/kernel-doc-HOWTO/all-in-a-tumble.rst
create mode 100644 Documentation/kernel-doc-HOWTO/conf.py
create mode 100644 Documentation/kernel-doc-HOWTO/csv_table.txt
create mode 100644 Documentation/kernel-doc-HOWTO/dbxml2rst_migration.rst
create mode 100644 Documentation/kernel-doc-HOWTO/index.rst
create mode 100644 Documentation/kernel-doc-HOWTO/kernel-doc-components.rst
create mode 100644 Documentation/kernel-doc-HOWTO/kernel-doc-directive.rst
create mode 100644 Documentation/kernel-doc-HOWTO/kernel-doc-examples.rst
create mode 100644 Documentation/kernel-doc-HOWTO/kernel-doc-intro.rst
create mode 100644 Documentation/kernel-doc-HOWTO/kernel-doc-syntax.rst
create mode 100644 Documentation/kernel-doc-HOWTO/kernel-doc-tests.rst
create mode 100644 Documentation/kernel-doc-HOWTO/reST-kernel-doc-mode.rst
create mode 100644 Documentation/kernel-doc-HOWTO/refs.txt
create mode 100644 Documentation/kernel-doc-HOWTO/table-markup.rst
create mode 100644 Documentation/kernel-doc-HOWTO/vintage-kernel-doc-mode.rst
delete mode 100644 Documentation/kernel-documentation.rst
create mode 100644 Documentation/reST-nano-HOWTO.rst
create mode 100644 Documentation/sphinx-static/theme_overrides.css
create mode 100644 Documentation/template-book/conf.py
create mode 100644 Documentation/template-book/get-started.rst
create mode 100644 Documentation/template-book/index.rst
create mode 100644 Documentation/template-book/licence.rst
create mode 100644 Documentation/template-book/refs.rst
create mode 100644 Documentation/template-book/refs.txt
create mode 100644 scripts/site-python/.gitignore
create mode 100644 scripts/site-python/README
create mode 100644 scripts/site-python/linuxdoc/__init__.py
create mode 100755 scripts/site-python/linuxdoc/kernel_doc.py
create mode 100755 scripts/site-python/linuxdoc/manKernelDoc.py
create mode 100755 scripts/site-python/linuxdoc/rstFlatTable.py
create mode 100755 scripts/site-python/linuxdoc/rstKernelDoc.py
^ permalink raw reply [flat|nested] 12+ messages in thread
* Re: [GIT PULL] doc: sphinx-4.8 DocBook to reST movement on Jon's docs-next
2016-06-28 16:41 [GIT PULL] doc: sphinx-4.8 DocBook to reST movement on Jon's docs-next Markus Heiser
@ 2016-06-28 19:05 ` Jani Nikula
2016-06-29 11:06 ` Markus Heiser
2016-06-29 16:24 ` Jonathan Corbet
1 sibling, 1 reply; 12+ messages in thread
From: Jani Nikula @ 2016-06-28 19:05 UTC (permalink / raw)
To: Markus Heiser, corbet, Mauro Carvalho Chehab
Cc: Dave Airlie, Markus Heiser, Grant Likely, Keith Packard,
LKML Mailing List, linux-doc, Hans Verkuil, Randy Dunlap
On Tue, 28 Jun 2016, Markus Heiser <markus.heiser@darmarit.de> wrote:
> Hi Jonathan, hi Mauro,
>
> here is my DocBook to reST movement on top of Jon's docs-next branch. It includes:
>
> * kernel-doc parser & directive
> * flat-table directive
> * man page builder 'kernel-doc-man'
> * the kernel-doc-HOWTO
> * guides for starters (reST-nano-HOWTO.rst & template-book)
> * A index-page which bundles the lose Documentation/*.rst files.
> * sub sphinx-projects aka *books* under Documentation/*/conf.py
> * a full DocBook-XML to reST migration (*books* matching
> Documentation/books_migrated/*/conf.py) described in [2]. The migration is
> based on the DocBook-XML content at commit 17defc2 from Johnatan's docs-next
> branch.
>
> I decided to comment out the pdf creation in the Makefile.reST, rst2pdf is to
> fragil see [2] (pdf is WIP).
>
> The output of html and man is included in the common %doc targets, to get
> more information about reST builds use:
>
> make books-help
>
> Any comments are welcome.
Perhaps you misunderstood, I don't know. When we ask you to rebase your
work on something, in this case docs-next, it generally means, accept
what is there, and iteratively build and extend upon it, *not* rip out
and rewrite everything from scratch.
Several people have spent a non-insignificant amount of time to review
and polish what is in docs-next currently. We've converted gpu
documentation on top, in drm-next, and set up autobuilders for it. We've
ironed out python2 vs python3 issues. We've fixed kernel-doc comments
here and there. Written documentation for the whole thing. Generally
tested the stuff in various environments. Etc, etc. That is the baseline
now, and it should be improved on iteratively, not destructively. That's
just sane engineering.
On the actual content (and really, this is orthogonal to the above),
I've repeatedly told you that I disagree with your approach to having
several configuration files, having the distinction between "books" and
other files, rewriting kernel-doc in python, having both rst and
"vintage" kernel-doc comments, converting all the docbook files in one
big lump. I won't repeat my rationale here, I've said it all before, but
sadly I don't see any of that addressed.
IMHO the most productive thing you could do right now is to send out
just the "flat table directive" patch. That's not controversial, and
would still have a chance to make it to v4.8.
BR,
Jani.
>
> -- Markus --
>
> [1] http://return42.github.io/sphkerneldoc/articles/dbtools.html
> [2] https://github.com/rst2pdf/rst2pdf/issues/556#issuecomment-228779542
>
>
> The following changes since commit 17defc282fe6e6ac93edbad8873ce89ef86b2490:
>
> Documentation: add meta-documentation for Sphinx and kernel-doc (2016-06-24 06:55:28 -0600)
>
> are available in the git repository at:
>
> https://github.com/return42/linux.git docs-next/linux-doc-reST
>
> for you to fetch changes up to 81bd813a599f8582570a735302ab660e20c7f442:
>
> doc-rst: full DocBook-XML to reST migration (docs-next) (2016-06-28 17:15:38 +0200)
>
> ----------------------------------------------------------------
>
> Markus Heiser (15):
> python: add scripts/site-packages
> kernel-doc-HOWTO: add kernel-doc specification
> doc-rst: add python package linuxdoc
> doc-rst: kernel-doc parser - inital python implementation
> doc-rst: kernel-doc directive - initial implementation
> doc-rst: flat-table directive - initial implementation
> doc-rst: kernel-doc-man sphinx builder - initial implementation
> doc-rst: add basic sphinx-build infrastructure
> doc-rst: add template book "Get started with reST"
> doc-rst: removed Jani's kernel-documentation.rst and index.rst
> doc-rst: infrastructure for *loose reST articles*
> doc-rst: add build-html decription to book-help.
> doc-rst: kernel-doc parser assert absolute pathname
> doc-rst: infrastructure for migrated DocBook-XML
> doc-rst: full DocBook-XML to reST migration (docs-next)
>
--
Jani Nikula, Intel Open Source Technology Center
^ permalink raw reply [flat|nested] 12+ messages in thread
* Re: [GIT PULL] doc: sphinx-4.8 DocBook to reST movement on Jon's docs-next
2016-06-28 19:05 ` Jani Nikula
@ 2016-06-29 11:06 ` Markus Heiser
2016-06-29 13:15 ` Jani Nikula
0 siblings, 1 reply; 12+ messages in thread
From: Markus Heiser @ 2016-06-29 11:06 UTC (permalink / raw)
To: Jani Nikula
Cc: corbet, Mauro Carvalho Chehab, Dave Airlie, Grant Likely,
Keith Packard, LKML Mailing List, linux-doc, Hans Verkuil,
Randy Dunlap
Am 28.06.2016 um 21:05 schrieb Jani Nikula <jani.nikula@intel.com>:
> On Tue, 28 Jun 2016, Markus Heiser <markus.heiser@darmarit.de> wrote:
>> Hi Jonathan, hi Mauro,
>>
>> here is my DocBook to reST movement on top of Jon's docs-next branch. It includes:
>>
>> * kernel-doc parser & directive
>> * flat-table directive
>> * man page builder 'kernel-doc-man'
>> * the kernel-doc-HOWTO
>> * guides for starters (reST-nano-HOWTO.rst & template-book)
>> * A index-page which bundles the lose Documentation/*.rst files.
>> * sub sphinx-projects aka *books* under Documentation/*/conf.py
>> * a full DocBook-XML to reST migration (*books* matching
>> Documentation/books_migrated/*/conf.py) described in [2]. The migration is
>> based on the DocBook-XML content at commit 17defc2 from Johnatan's docs-next
>> branch.
>>
>> I decided to comment out the pdf creation in the Makefile.reST, rst2pdf is to
>> fragil see [2] (pdf is WIP).
>>
>> The output of html and man is included in the common %doc targets, to get
>> more information about reST builds use:
>>
>> make books-help
>>
>> Any comments are welcome.
>
> Perhaps you misunderstood, I don't know. When we ask you to rebase your
> work on something, in this case docs-next, it generally means, accept
> what is there, and iteratively build and extend upon it, *not* rip out
> and rewrite everything from scratch.
>
> Several people have spent a non-insignificant amount of time to review
> and polish what is in docs-next currently. We've converted gpu
> documentation on top, in drm-next, and set up autobuilders for it. We've
> ironed out python2 vs python3 issues. We've fixed kernel-doc comments
> here and there. Written documentation for the whole thing. Generally
> tested the stuff in various environments. Etc, etc. That is the baseline
> now, and it should be improved on iteratively, not destructively. That's
> just sane engineering.
>
> On the actual content (and really, this is orthogonal to the above),
> I've repeatedly told you that I disagree with your approach to having
> several configuration files, having the distinction between "books" and
> other files, rewriting kernel-doc in python, having both rst and
> "vintage" kernel-doc comments, converting all the docbook files in one
> big lump. I won't repeat my rationale here, I've said it all before, but
> sadly I don't see any of that addressed.
>
> IMHO the most productive thing you could do right now is to send out
> just the "flat table directive" patch. That's not controversial, and
> would still have a chance to make it to v4.8.
>
> BR,
> Jani.
Take it as what it is:
a complete replacement of the XML toolchain.
IMHO, most of what you mentioned are assumptions, so my first
question is:
have you pulled and tested?
To be more concrete, *here* is what I tested on drm-next:
git checkout -b test123 airlied/drm-next
git pull https://github.com/return42/linux.git docs-next/linux-doc-reST
To complete the merge:
$ mv Documentation/books_migrated/gpu/conf.py Documentation/gpu
$ rm -rf Documentation/books_migrated/gpu
In the Documentation/gpu/conf.py drop the line: --> kernel_doc_mode = "kernel-doc"
In the Documentation/index.rst drop the line: --> gpu/index
$ make books/gpu.html
... perfect ...
and now some additional new features:
1.) If you want to see all the "Oops" of your document in one point,
add the ".. todolist::" directive in the gpu/index.rst :
2.) If you want to create manpages, add option ":man-sect: <man sect-no>"
to these ".. kernel-doc::" directives e.g:
<reST> ---------
.. kernel-doc:: drivers/gpu/drm/i915/i915_irq.c
:functions: intel_irq_init intel_irq_init_hw intel_hpd_init
:man-sect: 9
<reST> ---------
$ make books/gpu.man
...
writing man pages ... intel_irq_init.9
build succeeded, 43 warnings.
$ man -l Documentation/dist/books/gpu/man/intel_irq_init.9.gz
... perfect ...
3.) If you want to suppress headings of "DOC:" sections, add
option ":no-header:" to the kernel-doc directives selecting "DOC:",
do not suppress headings on declarations, this might end in unwanted
man-pages constructs.
BTW: You have to accept, that reST is a structured markup, the readers,
writers, translators and builders working with these structures. Inline
bold-faces like the ones, the kernel-doc perl script produce:
print "**Parameters**\n\n";
..
print "**$section**\n\n";
is more "painting a document", where a section structure (heading) is required.
> I've repeatedly told you that I disagree with your approach to having
> several configuration files, having the distinction between "books" and
> other files,
You want to build one great sphinx-project, a monolith where all is in.
I build those monoliths in the past and it was my fail. The roundtrips
of those monoliths increase, while the user acceptance decrease and
this is not a assumption, this is my practical experience from the
last 8 years with sphinx and reST.
> having both rst and
> "vintage" kernel-doc comments,
your scope is reduced on your single use-case, it is a parser option,
the default is "reST", so if you don't need a *vintage* mode simply
ignore it ... (see above and read the kernel-doc-HOWTO).
> converting all the docbook files in one
> big lump.
We don't have to. I shipped them in the "books_migration" folder for
your tests and to see how all current documentation will be build.
I also placed a README.txt in this folder ... read it.
John could drop this folder, but others like Mauro want to base on this
migration.
Now we can test the toolchain against the complete docs, have
you ever done this? ... now you could build your monolith (see below)
and test the roundtrips in practice ...
The py-parser you fear about, leafs the XML toolchain untouched, is more strict,
then the perl one and gives more warnings about all these buggy source code
comments ... and with the "NullTranslator" you get a great lint tool for free.
I studied all your's and John's patches on the perl one and checked if
the python one need a correction.
BTW: it parses only once and shows errors only ones (not n-times).
> I've said it all before, but
> sadly I don't see any of that addressed.
I addressed all your points and tried to evaluate solutions that match
(e.g. loose-text files, reST mode as default etc), but this does not imply,
that all your answers get a 1:1 implementation.
I remember about chunking large files, your answers "no, it breaks the
story" and with commit 2fa91d1 you start to chunk ...
now the discussion about sub-projects ... my recommendations comes from
a 8 year ongoing practice so please honor them a bit.
I also ask you for a close collaboration, but you didn't want. I'am at
the end of my ideas ...
> IMHO the most productive thing you could do right now is to send out
> just the "flat table directive" patch. That's not controversial, and
> would still have a chance to make it to v4.8.
Since your solution is not a full replacement (no man-page builder) and
does not produce structural markup ....
IMHO pull my solution, if you have any remarks, let me know. E.g if
you think it is better to use ":no-header:" as default on DOC:
sections, I implement it and test it against the complete docs.
-- Markus --
>
>>
>> -- Markus --
>>
>> [1] http://return42.github.io/sphkerneldoc/articles/dbtools.html
>> [2] https://github.com/rst2pdf/rst2pdf/issues/556#issuecomment-228779542
>>
>>
>> The following changes since commit 17defc282fe6e6ac93edbad8873ce89ef86b2490:
>>
>> Documentation: add meta-documentation for Sphinx and kernel-doc (2016-06-24 06:55:28 -0600)
>>
>> are available in the git repository at:
>>
>> https://github.com/return42/linux.git docs-next/linux-doc-reST
>>
>> for you to fetch changes up to 81bd813a599f8582570a735302ab660e20c7f442:
>>
>> doc-rst: full DocBook-XML to reST migration (docs-next) (2016-06-28 17:15:38 +0200)
>>
>> ----------------------------------------------------------------
>>
>> Markus Heiser (15):
>> python: add scripts/site-packages
>> kernel-doc-HOWTO: add kernel-doc specification
>> doc-rst: add python package linuxdoc
>> doc-rst: kernel-doc parser - inital python implementation
>> doc-rst: kernel-doc directive - initial implementation
>> doc-rst: flat-table directive - initial implementation
>> doc-rst: kernel-doc-man sphinx builder - initial implementation
>> doc-rst: add basic sphinx-build infrastructure
>> doc-rst: add template book "Get started with reST"
>> doc-rst: removed Jani's kernel-documentation.rst and index.rst
>> doc-rst: infrastructure for *loose reST articles*
>> doc-rst: add build-html decription to book-help.
>> doc-rst: kernel-doc parser assert absolute pathname
>> doc-rst: infrastructure for migrated DocBook-XML
>> doc-rst: full DocBook-XML to reST migration (docs-next)
>>
>
> --
> Jani Nikula, Intel Open Source Technology Center
^ permalink raw reply [flat|nested] 12+ messages in thread
* Re: [GIT PULL] doc: sphinx-4.8 DocBook to reST movement on Jon's docs-next
2016-06-29 11:06 ` Markus Heiser
@ 2016-06-29 13:15 ` Jani Nikula
2016-06-29 16:48 ` Markus Heiser
0 siblings, 1 reply; 12+ messages in thread
From: Jani Nikula @ 2016-06-29 13:15 UTC (permalink / raw)
To: Markus Heiser
Cc: corbet, Mauro Carvalho Chehab, Dave Airlie, Grant Likely,
Keith Packard, LKML Mailing List, linux-doc, Hans Verkuil,
Randy Dunlap
On Wed, 29 Jun 2016, Markus Heiser <markus.heiser@darmarit.de> wrote:
> Am 28.06.2016 um 21:05 schrieb Jani Nikula <jani.nikula@intel.com>:
>> Perhaps you misunderstood, I don't know. When we ask you to rebase your
>> work on something, in this case docs-next, it generally means, accept
>> what is there, and iteratively build and extend upon it, *not* rip out
>> and rewrite everything from scratch.
>>
>> Several people have spent a non-insignificant amount of time to review
>> and polish what is in docs-next currently. We've converted gpu
>> documentation on top, in drm-next, and set up autobuilders for it. We've
>> ironed out python2 vs python3 issues. We've fixed kernel-doc comments
>> here and there. Written documentation for the whole thing. Generally
>> tested the stuff in various environments. Etc, etc. That is the baseline
>> now, and it should be improved on iteratively, not destructively. That's
>> just sane engineering.
Please just read the above again, and try to let it sink in.
>> On the actual content (and really, this is orthogonal to the above),
>> I've repeatedly told you that I disagree with your approach to having
>> several configuration files, having the distinction between "books" and
>> other files, rewriting kernel-doc in python, having both rst and
>> "vintage" kernel-doc comments, converting all the docbook files in one
>> big lump. I won't repeat my rationale here, I've said it all before, but
>> sadly I don't see any of that addressed.
> Take it as what it is:
>
> a complete replacement of the XML toolchain.
>
> IMHO, most of what you mentioned are assumptions, so my first
> question is:
>
> have you pulled and tested?
I have looked at the patches and read the commit messages. If your work
was reasonably based on docs-next, iteratively improving on what is
there, we could have a sensible discussion on the relative merits of
each commit and change. Now, it all depends on being a full rewrite. It
depends on throwing out everything we've done so far. There isn't a
single commit that's a change or an improvement to existing code.
I'm obviously biased because I've done the bulk of the Sphinx work in
docs-next. Your pull request feels like a complicated way to tell me you
think it's all crap. I'll try to let that slide.
> Since your solution is not a full replacement (no man-page builder) and
> does not produce structural markup ....
>
> IMHO pull my solution, if you have any remarks, let me know. E.g if
> you think it is better to use ":no-header:" as default on DOC:
> sections, I implement it and test it against the complete docs.
You have plenty of good stuff in there. The annoying thing is that you
present it in a take-it-all-or-leave-it-all kind of way.
For example, it would be trivial to add the flat table directive to the
existing configuration file, but instead you opt to rewrite the entire
file. You could base your kernel-doc directive extension on the existing
one, but instead you rewrite it. And then add it in the configuration
file rewrite. And so on and so on.
I'll need to focus on other things now, and it's a good time to let
others chime in. It would have been nice to see iterative improvements
from you. Perhaps they could have made it to v4.8, the merge window
being just a few weeks away.
BR,
Jani.
--
Jani Nikula, Intel Open Source Technology Center
^ permalink raw reply [flat|nested] 12+ messages in thread
* Re: [GIT PULL] doc: sphinx-4.8 DocBook to reST movement on Jon's docs-next
2016-06-28 16:41 [GIT PULL] doc: sphinx-4.8 DocBook to reST movement on Jon's docs-next Markus Heiser
2016-06-28 19:05 ` Jani Nikula
@ 2016-06-29 16:24 ` Jonathan Corbet
2016-06-29 17:35 ` Markus Heiser
1 sibling, 1 reply; 12+ messages in thread
From: Jonathan Corbet @ 2016-06-29 16:24 UTC (permalink / raw)
To: Markus Heiser
Cc: Mauro Carvalho Chehab, Dave Airlie, Jani Nikula, Grant Likely,
Keith Packard, LKML Mailing List, linux-doc, Hans Verkuil,
Randy Dunlap
Hi, Markus,
I was glad to hear from you, but I have to agree with Jani: this is not
how things are done. Consider this one line:
> 706 files changed, 123369 insertions(+), 752 deletions(-)
Something like that will be a huge red flag to any kernel maintainer!
In the kernel community, we have spent the last 25 years figuring out a
development model that is based on gradual, incremental changes, each of
which can be reviewed on its own merits. It does *not* encompass
wholesale replacements of existing code — even in situations where that
code was not just merged after a year of discussions, negotiations, and
false starts.
I simply cannot accept this pull request.
Markus, we all very much want your help in this work. You have expertise
and energy that could really push the documentation effort forward. But
it needs to be done the way kernel developers do it: cooperatively,
incrementally, and always mindful of the entire community's needs.
I would love it if you would take the flat-table and man-page work,
separate them out, and make them work with the *existing* Sphinx-based
scheme. If you can do it soon, we can maybe get it into 4.8. Can you
focus on that for now, please?
As for the rest, what we have now is certainly far from perfect; we're
figuring a lot of this out as we go. Incremental improvements are
welcome, and each will be evaluated independently. Please help us to
make the kernel's documentation better that way.
Thanks,
jon
^ permalink raw reply [flat|nested] 12+ messages in thread
* Re: [GIT PULL] doc: sphinx-4.8 DocBook to reST movement on Jon's docs-next
2016-06-29 13:15 ` Jani Nikula
@ 2016-06-29 16:48 ` Markus Heiser
0 siblings, 0 replies; 12+ messages in thread
From: Markus Heiser @ 2016-06-29 16:48 UTC (permalink / raw)
To: Jani Nikula
Cc: corbet, Mauro Carvalho Chehab, Dave Airlie, Grant Likely,
Keith Packard, LKML Mailing List, linux-doc, Hans Verkuil,
Randy Dunlap
Am 29.06.2016 um 15:15 schrieb Jani Nikula <jani.nikula@intel.com>:
> On Wed, 29 Jun 2016, Markus Heiser <markus.heiser@darmarit.de> wrote:
>> Am 28.06.2016 um 21:05 schrieb Jani Nikula <jani.nikula@intel.com>:
>>> Perhaps you misunderstood, I don't know. When we ask you to rebase your
>>> work on something, in this case docs-next, it generally means, accept
>>> what is there, and iteratively build and extend upon it, *not* rip out
>>> and rewrite everything from scratch.
>>>
>>> Several people have spent a non-insignificant amount of time to review
>>> and polish what is in docs-next currently. We've converted gpu
>>> documentation on top, in drm-next, and set up autobuilders for it. We've
>>> ironed out python2 vs python3 issues. We've fixed kernel-doc comments
>>> here and there. Written documentation for the whole thing. Generally
>>> tested the stuff in various environments. Etc, etc. That is the baseline
>>> now, and it should be improved on iteratively, not destructively. That's
>>> just sane engineering.
>
> Please just read the above again, and try to let it sink in.
I know what you mean, read on about this "unlucky situation" ..
>
>>> On the actual content (and really, this is orthogonal to the above),
>>> I've repeatedly told you that I disagree with your approach to having
>>> several configuration files, having the distinction between "books" and
>>> other files, rewriting kernel-doc in python, having both rst and
>>> "vintage" kernel-doc comments, converting all the docbook files in one
>>> big lump. I won't repeat my rationale here, I've said it all before, but
>>> sadly I don't see any of that addressed.
>
>> Take it as what it is:
>>
>> a complete replacement of the XML toolchain.
>>
>> IMHO, most of what you mentioned are assumptions, so my first
>> question is:
>>
>> have you pulled and tested?
>
> I have looked at the patches and read the commit messages. If your work
> was reasonably based on docs-next, iteratively improving on what is
> there, we could have a sensible discussion on the relative merits of
> each commit and change. Now, it all depends on being a full rewrite. It
> depends on throwing out everything we've done so far. There isn't a
> single commit that's a change or an improvement to existing code.
>
> I'm obviously biased because I've done the bulk of the Sphinx work in
> docs-next. Your pull request feels like a complicated way to tell me you
> think it's all crap. I'll try to let that slide.
>
>> Since your solution is not a full replacement (no man-page builder) and
>> does not produce structural markup ....
>>
>> IMHO pull my solution, if you have any remarks, let me know. E.g if
>> you think it is better to use ":no-header:" as default on DOC:
>> sections, I implement it and test it against the complete docs.
>
> You have plenty of good stuff in there. The annoying thing is that you
> present it in a take-it-all-or-leave-it-all kind of way.
Yes, this was my mistake I'am sorry about.
I started 4 or 5 month ago with the migration in my POC [1] I posted
it on the ML, to show those who had doubt in reST & sphinx that it is
the right decision to switch from DocBook to reST. But the only one how
gives feedback about this was Mauro. We discussed some points and he
explained me some of the developer's requirements, this was productive
and the flat-table is one of the results.
My mistake: after I finished the migration, I continued to
develop the sphinx extensions in the POC and not on the docs-next.
Then I switched to base on a 4.7rc tag... yes, complete chaotic
Great mistake of mine not to base on the docs-next from the beginning.
... This is my first work in the kernel community and I was not familiar
with the organizational structures. I'am very sorry about and I will
improve myself on this.
In the further course you made huge steps forward and I thought
it is the best to let you work to get productive on that what you
have. While you needed to get productive, I needed more time,
it was "unlucky situation" ...
side node: It is not really a good alternative, but the history is
present in the POC [1]. E.g. here is one patch from you I ported
to the python kernel-doc module:
https://github.com/return42/sphkerneldoc/commit/9ac8fc9023400d26a6a0b6e7f741e1bf788d2326
Yes, I read through all your patches, made tests with your perl
script and compared it with the python one ... I got huge
benefit from your patches -- the situation and my strategy
was unlucky, but your investigation is not lost! -- and
to fix kernel-doc comments is always good.
> For example, it would be trivial to add the flat table directive to the
> existing configuration file, but instead you opt to rewrite the entire
> file.
The config file "replacement" is because, that my configuration
with sub-project is different to the config file from the sphinx
template. I also added more comments, dropped settings who are
not relevant and I moved settings like project, author etc. to the
top ... but forgot to drop my latex settings .. not really perfect.
> You could base your kernel-doc directive extension on the existing
> one, but instead you rewrite it.
No this is not possible. After I realized, that I'am at the end with
the perl script and I needed a API to the kernel-doc parser I started
the kernel_doc.py rewrite ... so the kernel-doc directive of mine
uses a kernel_doc.py API instead of pipes and a command line, thats
why the two implementation are so different.
> And then add it in the configuration
> file rewrite. And so on and so on.
>
> I'll need to focus on other things now, and it's a good time to let
> others chime in. It would have been nice to see iterative improvements
> from you. Perhaps they could have made it to v4.8, the merge window
> being just a few weeks away.
Mauro will start to migrate, I think we need this time to get more
practice ...
Regards
-- Markus --
[1] https://github.com/return42/sphkerneldoc
>
> BR,
> Jani.
>
>
> --
> Jani Nikula, Intel Open Source Technology Center
^ permalink raw reply [flat|nested] 12+ messages in thread
* Re: [GIT PULL] doc: sphinx-4.8 DocBook to reST movement on Jon's docs-next
2016-06-29 16:24 ` Jonathan Corbet
@ 2016-06-29 17:35 ` Markus Heiser
2016-06-29 17:52 ` Jonathan Corbet
0 siblings, 1 reply; 12+ messages in thread
From: Markus Heiser @ 2016-06-29 17:35 UTC (permalink / raw)
To: Jonathan Corbet
Cc: Mauro Carvalho Chehab, Dave Airlie, Jani Nikula, Grant Likely,
Keith Packard, LKML Mailing List, linux-doc, Hans Verkuil,
Randy Dunlap
Hi Jonathan,
Am 29.06.2016 um 18:24 schrieb Jonathan Corbet <corbet@lwn.net>:
> Hi, Markus,
>
> I was glad to hear from you, but I have to agree with Jani: this is not
> how things are done. Consider this one line:
>
>> 706 files changed, 123369 insertions(+), 752 deletions(-)
>
> Something like that will be a huge red flag to any kernel maintainer!
>
> In the kernel community, we have spent the last 25 years figuring out a
> development model that is based on gradual, incremental changes, each of
> which can be reviewed on its own merits. It does *not* encompass
> wholesale replacements of existing code — even in situations where that
> code was not just merged after a year of discussions, negotiations, and
> false starts.
Yes, my mistake, as I wrote to Jani.
> I simply cannot accept this pull request.
>
> Markus, we all very much want your help in this work. You have expertise
> and energy that could really push the documentation effort forward. But
> it needs to be done the way kernel developers do it: cooperatively,
> incrementally, and always mindful of the entire community's needs.
>
> I would love it if you would take the flat-table and man-page work,
> separate them out, and make them work with the *existing* Sphinx-based
> scheme. If you can do it soon, we can maybe get it into 4.8. Can you
> focus on that for now, please?
Yes, I will send you flat-table request in the next days.
> As for the rest, what we have now is certainly far from perfect; we're
> figuring a lot of this out as we go. Incremental improvements are
> welcome, and each will be evaluated independently. Please help us to
> make the kernel's documentation better that way.
I'am willing to do so, but I need some help / suggestions:
1. I have this extensions in the scripts/site-python/linuxdoc.
What do you recommend, how could I split this up in a patch
series which is more evaluated.
.. I wrote to Jani, that my approach was chaotic in the past
and I'am sorry for this. But now I'am sitting in front of this
bulk of source and I'am bit helpless how to split ... I will
try to make it more elaborate, but it will be helpfull if
you point me the right direction ...
2. What is the best way to ship these migrations
or better I asked, what is your recommendation for a
migration strategy. Jani says, that this better belongs
to authors, but I have a doubt that we end with the
migration in the next years, if we wait about every author.
I think, supporting both infrastructures - the xml and the
reST - over a long period is not the best option. What is
your recommendation on this?
Regards
-- Markus --
>
> Thanks,
>
> jon
^ permalink raw reply [flat|nested] 12+ messages in thread
* Re: [GIT PULL] doc: sphinx-4.8 DocBook to reST movement on Jon's docs-next
2016-06-29 17:35 ` Markus Heiser
@ 2016-06-29 17:52 ` Jonathan Corbet
2016-06-29 20:57 ` Mauro Carvalho Chehab
2016-06-30 8:53 ` Markus Heiser
0 siblings, 2 replies; 12+ messages in thread
From: Jonathan Corbet @ 2016-06-29 17:52 UTC (permalink / raw)
To: Markus Heiser
Cc: Mauro Carvalho Chehab, Dave Airlie, Jani Nikula, Grant Likely,
Keith Packard, LKML Mailing List, linux-doc, Hans Verkuil,
Randy Dunlap
On Wed, 29 Jun 2016 19:35:46 +0200
Markus Heiser <markus.heiser@darmarit.de> wrote:
> > I would love it if you would take the flat-table and man-page work,
> > separate them out, and make them work with the *existing* Sphinx-based
> > scheme. If you can do it soon, we can maybe get it into 4.8. Can you
> > focus on that for now, please?
>
> Yes, I will send you flat-table request in the next days.
I'm glad to hear that. One request: please post it as a patch, rather than
as a pull request; that makes it easier for everybody to review it.
> > As for the rest, what we have now is certainly far from perfect; we're
> > figuring a lot of this out as we go. Incremental improvements are
> > welcome, and each will be evaluated independently. Please help us to
> > make the kernel's documentation better that way.
>
> I'am willing to do so, but I need some help / suggestions:
>
> 1. I have this extensions in the scripts/site-python/linuxdoc.
> What do you recommend, how could I split this up in a patch
> series which is more evaluated.
>
> .. I wrote to Jani, that my approach was chaotic in the past
> and I'am sorry for this. But now I'am sitting in front of this
> bulk of source and I'am bit helpless how to split ... I will
> try to make it more elaborate, but it will be helpfull if
> you point me the right direction ...
Try to break it down as much as possible so that each patch represents a
single logical change. Each bit that you can break out reduces the problem
space a bit, and often helps with the rest. If possible, I'd like to
suggest starting with the man-page generation, since that's a hole in the
current system. I'll have to fill it if you don't :)
Please note that I'd really like to see this stuff done without big changes
like the wholesale replacement of kernel-doc with a version in a different
language. Someday we might want to make a change like that, but one step
at a time.
> 2. What is the best way to ship these migrations
>
> or better I asked, what is your recommendation for a
> migration strategy. Jani says, that this better belongs
> to authors, but I have a doubt that we end with the
> migration in the next years, if we wait about every author.
> I think, supporting both infrastructures - the xml and the
> reST - over a long period is not the best option. What is
> your recommendation on this?
I think we need to give maintainers the first shot at doing the conversion;
in any case, I don't think we can just force it through without their
cooperation. And, honestly, while we're still groping around in this
space, I think it's fine if we don't have lots of conversions right away.
The ones that go more slowly will benefit from what we learn with the easy
ones.
You could certainly talk to maintainers and see if they would like
assistance with specific books. Helping Mauro to get his tables done
without going totally nuts would be a great first step, IMO.
That said, if you're wanting to convert documents, there is a set of older
ones in the docbook directory that have no current maintainer and will
never move over on their own. kernel-hacking.tmpl is an obvious example.
The problem with these, of course, is that they are *way* out of date in
general, and really need attention beyond just a format conversion. I
won't say one has to happen before the other, but I am unsure that we will
really benefit from convert-and-forget-again efforts.
Thanks,
jon
^ permalink raw reply [flat|nested] 12+ messages in thread
* Re: [GIT PULL] doc: sphinx-4.8 DocBook to reST movement on Jon's docs-next
2016-06-29 17:52 ` Jonathan Corbet
@ 2016-06-29 20:57 ` Mauro Carvalho Chehab
2016-06-30 9:25 ` Markus Heiser
2016-06-30 8:53 ` Markus Heiser
1 sibling, 1 reply; 12+ messages in thread
From: Mauro Carvalho Chehab @ 2016-06-29 20:57 UTC (permalink / raw)
To: Jonathan Corbet
Cc: Markus Heiser, Dave Airlie, Jani Nikula, Grant Likely,
Keith Packard, LKML Mailing List, linux-doc, Hans Verkuil,
Randy Dunlap
Em Wed, 29 Jun 2016 11:52:09 -0600
Jonathan Corbet <corbet@lwn.net> escreveu:
> > 2. What is the best way to ship these migrations
> >
> > or better I asked, what is your recommendation for a
> > migration strategy. Jani says, that this better belongs
> > to authors, but I have a doubt that we end with the
> > migration in the next years, if we wait about every author.
> > I think, supporting both infrastructures - the xml and the
> > reST - over a long period is not the best option. What is
> > your recommendation on this?
>
> I think we need to give maintainers the first shot at doing the conversion;
> in any case, I don't think we can just force it through without their
> cooperation. And, honestly, while we're still groping around in this
> space, I think it's fine if we don't have lots of conversions right away.
> The ones that go more slowly will benefit from what we learn with the easy
> ones.
>
> You could certainly talk to maintainers and see if they would like
> assistance with specific books. Helping Mauro to get his tables done
> without going totally nuts would be a great first step, IMO.
Yeah, going to each maintainer is the best way, as we're the ones
that will be bothered if something goes wrong on the documentation
(and code) that we maintain.
In the specific case of media stuff, the first step is to get the
flat-tree support and to put the migrated documentation on a separate
directory. Unfortunately, I have two sets of topic branches for 4.8,
and they both touch at the media docbook (and nothing prevents that
similar things to happen on 4.9 or any other version).
So, my plan is to keep both reST and docbook on Kernel for a while,
until be sure that everything is properly migrated.
Yet, I'm not sure if we should keep the migration scripts at the
Kernel tree, or if the best is to keep them in separate, as I
intend to not take more than one Kernel version to finish the
conversion. At least for media docbook, this will be a one-time
conversion.
So, I really appreciate if you could send me the patches with
the converted media documentation that you did. I'll merge it
after Jonathan applies the flat-tree patch on his tree, and
start reviewing and fixing the documentation over the main
branch. I'll need to track the topic branch changes at the
Docbook, to apply them again at the master tree, once they
gets merged during the 4.8 window. Thankfully, there aren't
complex elements on such changes (as far as I remember).
If everything goes right, by -rc2 or -rc3 I'll likely be dropping
the DocBook/media from my tree.
--
Thanks,
Mauro
^ permalink raw reply [flat|nested] 12+ messages in thread
* Re: [GIT PULL] doc: sphinx-4.8 DocBook to reST movement on Jon's docs-next
2016-06-29 17:52 ` Jonathan Corbet
2016-06-29 20:57 ` Mauro Carvalho Chehab
@ 2016-06-30 8:53 ` Markus Heiser
1 sibling, 0 replies; 12+ messages in thread
From: Markus Heiser @ 2016-06-30 8:53 UTC (permalink / raw)
To: Jonathan Corbet
Cc: Mauro Carvalho Chehab, Dave Airlie, Jani Nikula, Grant Likely,
Keith Packard, LKML Mailing List, linux-doc, Hans Verkuil,
Randy Dunlap
Hi Jonathan,
Am 29.06.2016 um 19:52 schrieb Jonathan Corbet <corbet@lwn.net>:
> On Wed, 29 Jun 2016 19:35:46 +0200
> Markus Heiser <markus.heiser@darmarit.de> wrote:
>
>>> I would love it if you would take the flat-table and man-page work,
>>> separate them out, and make them work with the *existing* Sphinx-based
>>> scheme. If you can do it soon, we can maybe get it into 4.8. Can you
>>> focus on that for now, please?
>>
>> Yes, I will send you flat-table request in the next days.
>
> I'm glad to hear that. One request: please post it as a patch, rather than
> as a pull request; that makes it easier for everybody to review it.
>
>>> As for the rest, what we have now is certainly far from perfect; we're
>>> figuring a lot of this out as we go. Incremental improvements are
>>> welcome, and each will be evaluated independently. Please help us to
>>> make the kernel's documentation better that way.
>>
>> I'am willing to do so, but I need some help / suggestions:
>>
>> 1. I have this extensions in the scripts/site-python/linuxdoc.
>> What do you recommend, how could I split this up in a patch
>> series which is more evaluated.
>>
>> .. I wrote to Jani, that my approach was chaotic in the past
>> and I'am sorry for this. But now I'am sitting in front of this
>> bulk of source and I'am bit helpless how to split ... I will
>> try to make it more elaborate, but it will be helpfull if
>> you point me the right direction ...
>
> Try to break it down as much as possible so that each patch represents a
> single logical change. Each bit that you can break out reduces the problem
> space a bit, and often helps with the rest. If possible, I'd like to
> suggest starting with the man-page generation, since that's a hole in the
> current system. I'll have to fill it if you don't :)
Give me a bit time, I will do it. At first flat-table, then man-page.
> Please note that I'd really like to see this stuff done without big changes
> like the wholesale replacement of kernel-doc with a version in a different
> language. Someday we might want to make a change like that, but one step
> at a time.
mmh, OK ... it will be "the long run" for me ... I will take it (again). The
replacement makes many things much easier and has this big features; to parse
only once (not on every kernel-doc directive / one error log, not n times same
error messages) and a rich interface to control the reST output fine grained (
and Snippets, and a NullTranslator as a lint for free and .. and) ... it is a
good working base ... no need for breadcrumbs or other tricky workarounds ...
OK, I will start improving the perl script insofar it is needed (the reST out
has to be more structural, you will see it / if it comes to the man-page builder)
... may be later I could persuade you, that it is a "dead end street" ... if the
language python is the problem, I could maintain these modules (15 years practice).
Regards
--Markus--
>> 2. What is the best way to ship these migrations
>>
>> or better I asked, what is your recommendation for a
>> migration strategy. Jani says, that this better belongs
>> to authors, but I have a doubt that we end with the
>> migration in the next years, if we wait about every author.
>> I think, supporting both infrastructures - the xml and the
>> reST - over a long period is not the best option. What is
>> your recommendation on this?
>
> I think we need to give maintainers the first shot at doing the conversion;
> in any case, I don't think we can just force it through without their
> cooperation. And, honestly, while we're still groping around in this
> space, I think it's fine if we don't have lots of conversions right away.
> The ones that go more slowly will benefit from what we learn with the easy
> ones.
>
> You could certainly talk to maintainers and see if they would like
> assistance with specific books. Helping Mauro to get his tables done
> without going totally nuts would be a great first step, IMO.
>
> That said, if you're wanting to convert documents, there is a set of older
> ones in the docbook directory that have no current maintainer and will
> never move over on their own. kernel-hacking.tmpl is an obvious example.
> The problem with these, of course, is that they are *way* out of date in
> general, and really need attention beyond just a format conversion. I
> won't say one has to happen before the other, but I am unsure that we will
> really benefit from convert-and-forget-again efforts.
>
> Thanks,
>
> jon
^ permalink raw reply [flat|nested] 12+ messages in thread
* Re: [GIT PULL] doc: sphinx-4.8 DocBook to reST movement on Jon's docs-next
2016-06-29 20:57 ` Mauro Carvalho Chehab
@ 2016-06-30 9:25 ` Markus Heiser
2016-06-30 10:18 ` Mauro Carvalho Chehab
0 siblings, 1 reply; 12+ messages in thread
From: Markus Heiser @ 2016-06-30 9:25 UTC (permalink / raw)
To: Mauro Carvalho Chehab
Cc: Jonathan Corbet, Dave Airlie, Jani Nikula, Grant Likely,
Keith Packard, LKML Mailing List, linux-doc, Hans Verkuil,
Randy Dunlap
Am 29.06.2016 um 22:57 schrieb Mauro Carvalho Chehab <mchehab@osg.samsung.com>:
> Em Wed, 29 Jun 2016 11:52:09 -0600
> Jonathan Corbet <corbet@lwn.net> escreveu:
>
>>> 2. What is the best way to ship these migrations
>>>
>>> or better I asked, what is your recommendation for a
>>> migration strategy. Jani says, that this better belongs
>>> to authors, but I have a doubt that we end with the
>>> migration in the next years, if we wait about every author.
>>> I think, supporting both infrastructures - the xml and the
>>> reST - over a long period is not the best option. What is
>>> your recommendation on this?
>>
>> I think we need to give maintainers the first shot at doing the conversion;
>> in any case, I don't think we can just force it through without their
>> cooperation. And, honestly, while we're still groping around in this
>> space, I think it's fine if we don't have lots of conversions right away.
>> The ones that go more slowly will benefit from what we learn with the easy
>> ones.
>>
>> You could certainly talk to maintainers and see if they would like
>> assistance with specific books. Helping Mauro to get his tables done
>> without going totally nuts would be a great first step, IMO.
>
> Yeah, going to each maintainer is the best way, as we're the ones
> that will be bothered if something goes wrong on the documentation
> (and code) that we maintain.
Later if I have more time, may I will pick up those books who need
only small correction e.g. "debugobjects" .. but when the time comes
I will contact the maintainer and Jon' first.
> In the specific case of media stuff, the first step is to get the
> flat-tree support and to put the migrated documentation on a separate
> directory. Unfortunately, I have two sets of topic branches for 4.8,
> and they both touch at the media docbook (and nothing prevents that
> similar things to happen on 4.9 or any other version).
>
> So, my plan is to keep both reST and docbook on Kernel for a while,
> until be sure that everything is properly migrated.
>
> Yet, I'm not sure if we should keep the migration scripts at the
> Kernel tree, or if the best is to keep them in separate, as I
> intend to not take more than one Kernel version to finish the
> conversion. At least for media docbook, this will be a one-time
> conversion.
If I understood you right: the scripts, which are made the
migration itself should not committed to the kernel tree (IMHO).
Currently the scripts are available at my POC, may I could
separate them into a python package which could be installed
via python's pip. So if one wants to use this procedure of
migration, he could install the package locally, make the
conversion and after finishing, he uninstall the package.
> So, I really appreciate if you could send me the patches with
> the converted media documentation that you did. I'll merge it
> after Jonathan applies the flat-tree patch on his tree, and
> start reviewing and fixing the documentation over the main
> branch.
Yes, first flat-table to Jon', then the converted media book
to Mauro, after this the man-page builder to Jon ... as long
as there are no man-pages in media it should be smoothly.
But I need a bit time, hopefully, end next week you got the
media patch from me.
-- Markus --
> I'll need to track the topic branch changes at the
> Docbook, to apply them again at the master tree, once they
> gets merged during the 4.8 window. Thankfully, there aren't
> complex elements on such changes (as far as I remember).
>
> If everything goes right, by -rc2 or -rc3 I'll likely be dropping
> the DocBook/media from my tree.
>
> --
> Thanks,
> Mauro
^ permalink raw reply [flat|nested] 12+ messages in thread
* Re: [GIT PULL] doc: sphinx-4.8 DocBook to reST movement on Jon's docs-next
2016-06-30 9:25 ` Markus Heiser
@ 2016-06-30 10:18 ` Mauro Carvalho Chehab
0 siblings, 0 replies; 12+ messages in thread
From: Mauro Carvalho Chehab @ 2016-06-30 10:18 UTC (permalink / raw)
To: Markus Heiser
Cc: Jonathan Corbet, Dave Airlie, Jani Nikula, Grant Likely,
Keith Packard, LKML Mailing List, linux-doc, Hans Verkuil,
Randy Dunlap
Em Thu, 30 Jun 2016 11:25:11 +0200
Markus Heiser <markus.heiser@darmarit.de> escreveu:
> Am 29.06.2016 um 22:57 schrieb Mauro Carvalho Chehab <mchehab@osg.samsung.com>:
>
> > Em Wed, 29 Jun 2016 11:52:09 -0600
> > Jonathan Corbet <corbet@lwn.net> escreveu:
> >
> >>> 2. What is the best way to ship these migrations
> >>>
> >>> or better I asked, what is your recommendation for a
> >>> migration strategy. Jani says, that this better belongs
> >>> to authors, but I have a doubt that we end with the
> >>> migration in the next years, if we wait about every author.
> >>> I think, supporting both infrastructures - the xml and the
> >>> reST - over a long period is not the best option. What is
> >>> your recommendation on this?
> >>
> >> I think we need to give maintainers the first shot at doing the conversion;
> >> in any case, I don't think we can just force it through without their
> >> cooperation. And, honestly, while we're still groping around in this
> >> space, I think it's fine if we don't have lots of conversions right away.
> >> The ones that go more slowly will benefit from what we learn with the easy
> >> ones.
> >>
> >> You could certainly talk to maintainers and see if they would like
> >> assistance with specific books. Helping Mauro to get his tables done
> >> without going totally nuts would be a great first step, IMO.
> >
> > Yeah, going to each maintainer is the best way, as we're the ones
> > that will be bothered if something goes wrong on the documentation
> > (and code) that we maintain.
>
> Later if I have more time, may I will pick up those books who need
> only small correction e.g. "debugobjects" .. but when the time comes
> I will contact the maintainer and Jon' first.
>
> > In the specific case of media stuff, the first step is to get the
> > flat-tree support and to put the migrated documentation on a separate
> > directory. Unfortunately, I have two sets of topic branches for 4.8,
> > and they both touch at the media docbook (and nothing prevents that
> > similar things to happen on 4.9 or any other version).
> >
> > So, my plan is to keep both reST and docbook on Kernel for a while,
> > until be sure that everything is properly migrated.
> >
> > Yet, I'm not sure if we should keep the migration scripts at the
> > Kernel tree, or if the best is to keep them in separate, as I
> > intend to not take more than one Kernel version to finish the
> > conversion. At least for media docbook, this will be a one-time
> > conversion.
>
> If I understood you right: the scripts, which are made the
> migration itself should not committed to the kernel tree (IMHO).
> Currently the scripts are available at my POC, may I could
> separate them into a python package which could be installed
> via python's pip. So if one wants to use this procedure of
> migration, he could install the package locally, make the
> conversion and after finishing, he uninstall the package.
Sounds like a plan.
>
> > So, I really appreciate if you could send me the patches with
> > the converted media documentation that you did. I'll merge it
> > after Jonathan applies the flat-tree patch on his tree, and
> > start reviewing and fixing the documentation over the main
> > branch.
>
> Yes, first flat-table to Jon', then the converted media book
> to Mauro, after this the man-page builder to Jon ... as long
> as there are no man-pages in media it should be smoothly.
OK.
> But I need a bit time, hopefully, end next week you got the
> media patch from me.
Ok, but please notice that the end of the next week is probably too late
for 4.8. Next week, we'll be on -rc6, and most maintainers freeze their
trees during -rc7, except for bug fixes. Ok, as this is just documentation
and should not cause regressions, I may open an exception, if it won't
cause any troubles to Jon.
>
> -- Markus --
>
> > I'll need to track the topic branch changes at the
> > Docbook, to apply them again at the master tree, once they
> > gets merged during the 4.8 window. Thankfully, there aren't
> > complex elements on such changes (as far as I remember).
> >
> > If everything goes right, by -rc2 or -rc3 I'll likely be dropping
> > the DocBook/media from my tree.
> >
> > --
> > Thanks,
> > Mauro
>
--
Thanks,
Mauro
^ permalink raw reply [flat|nested] 12+ messages in thread
end of thread, other threads:[~2016-06-30 10:20 UTC | newest]
Thread overview: 12+ messages (download: mbox.gz / follow: Atom feed)
-- links below jump to the message on this page --
2016-06-28 16:41 [GIT PULL] doc: sphinx-4.8 DocBook to reST movement on Jon's docs-next Markus Heiser
2016-06-28 19:05 ` Jani Nikula
2016-06-29 11:06 ` Markus Heiser
2016-06-29 13:15 ` Jani Nikula
2016-06-29 16:48 ` Markus Heiser
2016-06-29 16:24 ` Jonathan Corbet
2016-06-29 17:35 ` Markus Heiser
2016-06-29 17:52 ` Jonathan Corbet
2016-06-29 20:57 ` Mauro Carvalho Chehab
2016-06-30 9:25 ` Markus Heiser
2016-06-30 10:18 ` Mauro Carvalho Chehab
2016-06-30 8:53 ` Markus Heiser
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).