* [PATCH v2 0/9] Convert the remaining text files to ReST and add SPDX for GFDL
@ 2020-06-23 9:52 Mauro Carvalho Chehab
2020-06-23 9:52 ` [PATCH v2 1/9] docs: dt: convert booting-without-of.txt to ReST format Mauro Carvalho Chehab
` (8 more replies)
0 siblings, 9 replies; 15+ messages in thread
From: Mauro Carvalho Chehab @ 2020-06-23 9:52 UTC (permalink / raw)
To: Linux Doc Mailing List
Cc: Mauro Carvalho Chehab, linux-kernel, Jonathan Corbet, Bingbu Cao,
Maxime Ripard, Yong Zhi, Thomas Gleixner, Tian Shu Qiu,
Rob Herring, devicetree, linux-spdx, linux-mm, linux-media,
dri-devel, Greg Kroah-Hartman, Andrew Morton, Sakari Ailus,
Harry Wei, David Airlie, Maarten Lankhorst, Daniel Vetter,
Thomas Zimmermann, Hans Verkuil, Alex Shi
The main goal of this series is to finish the ReST conversion. After this
series, we have just those files still in plain old format:
- Documentation/RCU/RTFP.txt
- Documentation/atomic_bitops.txt
- Documentation/memory-barriers.txt
- Documentation/atomic_t.txt
- Documentation/filesystems/dax.txt
- Documentation/filesystems/path-lookup.txt
- Documentation/virt/kvm/devices/README
PS.: I'm using a script to remove false-positives and ignore non-converted
translated files.
It is worth to mention that this fseries contain licenses for the two
GFDL licenses used within the Kernel: GFDL-1.1+ and GFDL-1.2.
Those licenses are the result of long discussions with the SPDX legal
team, and are part of this commit, to be added for the future
SPDX 3.10 version:
https://github.com/spdx/license-list-XML/pull/1048/commits/f695d2ac65230d0f4161ba58fff2f9d87bb5a053
Mauro Carvalho Chehab (9):
docs: dt: convert booting-without-of.txt to ReST format
LICENSES: add GFDL licenses
media: docs: use SPDX GFDL-1.1-or-later-no-invariants
docs: trace: ring-buffer-design.txt: convert to ReST format
docs: move nommu-mmap.txt to admin-guide and rename to ReST
docs: move mailbox.txt to driver-api and rename it
docs: move other kAPI documents to core-api
docs: Add remaining Documentation/*.txt at staging/index.rst
docs: staging: use small font for literal includes
Documentation/admin-guide/mm/index.rst | 1 +
.../mm/nommu-mmap.rst} | 0
Documentation/admin-guide/sysctl/vm.rst | 2 +-
Documentation/arm/booting.rst | 2 +-
.../bus-virt-phys-mapping.rst} | 0
Documentation/core-api/index.rst | 3 +
.../this_cpu_ops.rst} | 0
.../unaligned-memory-access.rst | 0
...-without-of.txt => booting-without-of.rst} | 298 ++++---
Documentation/devicetree/index.rst | 1 +
Documentation/driver-api/index.rst | 1 +
.../{mailbox.txt => driver-api/mailbox.rst} | 0
Documentation/gpu/drm-mm.rst | 2 +-
Documentation/staging/index.rst | 24 +
Documentation/trace/index.rst | 1 +
...ffer-design.txt => ring-buffer-design.rst} | 778 +++++++++---------
Documentation/translations/zh_CN/arm/Booting | 2 +-
.../userspace-api/media/cec/cec-api.rst | 9 +-
.../media/cec/cec-func-close.rst | 9 +-
.../media/cec/cec-func-ioctl.rst | 9 +-
.../userspace-api/media/cec/cec-func-open.rst | 9 +-
.../userspace-api/media/cec/cec-func-poll.rst | 9 +-
.../userspace-api/media/cec/cec-funcs.rst | 9 +-
.../userspace-api/media/cec/cec-header.rst | 9 +-
.../userspace-api/media/cec/cec-intro.rst | 9 +-
.../media/cec/cec-ioc-adap-g-caps.rst | 9 +-
.../media/cec/cec-ioc-adap-g-log-addrs.rst | 9 +-
.../media/cec/cec-ioc-adap-g-phys-addr.rst | 9 +-
.../media/cec/cec-ioc-dqevent.rst | 9 +-
.../media/cec/cec-ioc-g-mode.rst | 9 +-
.../media/cec/cec-ioc-receive.rst | 9 +-
.../media/cec/cec-pin-error-inj.rst | 9 +-
.../dvb/audio-bilingual-channel-select.rst | 9 +-
.../media/dvb/audio-channel-select.rst | 9 +-
.../media/dvb/audio-clear-buffer.rst | 9 +-
.../media/dvb/audio-continue.rst | 9 +-
.../userspace-api/media/dvb/audio-fclose.rst | 9 +-
.../userspace-api/media/dvb/audio-fopen.rst | 9 +-
.../userspace-api/media/dvb/audio-fwrite.rst | 9 +-
.../media/dvb/audio-get-capabilities.rst | 9 +-
.../media/dvb/audio-get-status.rst | 9 +-
.../userspace-api/media/dvb/audio-pause.rst | 9 +-
.../userspace-api/media/dvb/audio-play.rst | 9 +-
.../media/dvb/audio-select-source.rst | 9 +-
.../media/dvb/audio-set-av-sync.rst | 9 +-
.../media/dvb/audio-set-bypass-mode.rst | 9 +-
.../userspace-api/media/dvb/audio-set-id.rst | 9 +-
.../media/dvb/audio-set-mixer.rst | 9 +-
.../media/dvb/audio-set-mute.rst | 9 +-
.../media/dvb/audio-set-streamtype.rst | 9 +-
.../userspace-api/media/dvb/audio-stop.rst | 9 +-
.../userspace-api/media/dvb/audio.rst | 9 +-
.../media/dvb/audio_data_types.rst | 9 +-
.../media/dvb/audio_function_calls.rst | 9 +-
.../userspace-api/media/dvb/ca-fclose.rst | 9 +-
.../userspace-api/media/dvb/ca-fopen.rst | 9 +-
.../userspace-api/media/dvb/ca-get-cap.rst | 9 +-
.../media/dvb/ca-get-descr-info.rst | 9 +-
.../userspace-api/media/dvb/ca-get-msg.rst | 9 +-
.../media/dvb/ca-get-slot-info.rst | 9 +-
.../userspace-api/media/dvb/ca-reset.rst | 9 +-
.../userspace-api/media/dvb/ca-send-msg.rst | 9 +-
.../userspace-api/media/dvb/ca-set-descr.rst | 9 +-
Documentation/userspace-api/media/dvb/ca.rst | 9 +-
.../userspace-api/media/dvb/ca_data_types.rst | 9 +-
.../media/dvb/ca_function_calls.rst | 9 +-
.../userspace-api/media/dvb/demux.rst | 9 +-
.../userspace-api/media/dvb/dmx-add-pid.rst | 9 +-
.../userspace-api/media/dvb/dmx-expbuf.rst | 9 +-
.../userspace-api/media/dvb/dmx-fclose.rst | 9 +-
.../userspace-api/media/dvb/dmx-fopen.rst | 9 +-
.../userspace-api/media/dvb/dmx-fread.rst | 9 +-
.../userspace-api/media/dvb/dmx-fwrite.rst | 9 +-
.../media/dvb/dmx-get-pes-pids.rst | 9 +-
.../userspace-api/media/dvb/dmx-get-stc.rst | 9 +-
.../userspace-api/media/dvb/dmx-mmap.rst | 9 +-
.../userspace-api/media/dvb/dmx-munmap.rst | 9 +-
.../userspace-api/media/dvb/dmx-qbuf.rst | 9 +-
.../userspace-api/media/dvb/dmx-querybuf.rst | 9 +-
.../media/dvb/dmx-remove-pid.rst | 9 +-
.../userspace-api/media/dvb/dmx-reqbufs.rst | 9 +-
.../media/dvb/dmx-set-buffer-size.rst | 9 +-
.../media/dvb/dmx-set-filter.rst | 9 +-
.../media/dvb/dmx-set-pes-filter.rst | 9 +-
.../userspace-api/media/dvb/dmx-start.rst | 9 +-
.../userspace-api/media/dvb/dmx-stop.rst | 9 +-
.../userspace-api/media/dvb/dmx_fcalls.rst | 9 +-
.../userspace-api/media/dvb/dmx_types.rst | 9 +-
.../media/dvb/dvb-fe-read-status.rst | 9 +-
.../media/dvb/dvb-frontend-event.rst | 9 +-
.../media/dvb/dvb-frontend-parameters.rst | 9 +-
.../userspace-api/media/dvb/dvbapi.rst | 9 +-
.../userspace-api/media/dvb/dvbproperty.rst | 9 +-
.../userspace-api/media/dvb/examples.rst | 9 +-
.../media/dvb/fe-bandwidth-t.rst | 9 +-
.../media/dvb/fe-diseqc-recv-slave-reply.rst | 9 +-
.../media/dvb/fe-diseqc-reset-overload.rst | 9 +-
.../media/dvb/fe-diseqc-send-burst.rst | 9 +-
.../media/dvb/fe-diseqc-send-master-cmd.rst | 9 +-
.../dvb/fe-dishnetwork-send-legacy-cmd.rst | 9 +-
.../media/dvb/fe-enable-high-lnb-voltage.rst | 9 +-
.../userspace-api/media/dvb/fe-get-event.rst | 9 +-
.../media/dvb/fe-get-frontend.rst | 9 +-
.../userspace-api/media/dvb/fe-get-info.rst | 9 +-
.../media/dvb/fe-get-property.rst | 9 +-
.../userspace-api/media/dvb/fe-read-ber.rst | 9 +-
.../media/dvb/fe-read-signal-strength.rst | 9 +-
.../userspace-api/media/dvb/fe-read-snr.rst | 9 +-
.../media/dvb/fe-read-status.rst | 9 +-
.../media/dvb/fe-read-uncorrected-blocks.rst | 9 +-
.../media/dvb/fe-set-frontend-tune-mode.rst | 9 +-
.../media/dvb/fe-set-frontend.rst | 9 +-
.../userspace-api/media/dvb/fe-set-tone.rst | 9 +-
.../media/dvb/fe-set-voltage.rst | 9 +-
.../userspace-api/media/dvb/fe-type-t.rst | 9 +-
.../media/dvb/fe_property_parameters.rst | 9 +-
.../media/dvb/frontend-header.rst | 9 +-
.../dvb/frontend-property-cable-systems.rst | 9 +-
.../frontend-property-satellite-systems.rst | 9 +-
.../frontend-property-terrestrial-systems.rst | 9 +-
.../media/dvb/frontend-stat-properties.rst | 9 +-
.../userspace-api/media/dvb/frontend.rst | 9 +-
.../media/dvb/frontend_f_close.rst | 9 +-
.../media/dvb/frontend_f_open.rst | 9 +-
.../media/dvb/frontend_fcalls.rst | 9 +-
.../media/dvb/frontend_legacy_api.rst | 9 +-
.../media/dvb/frontend_legacy_dvbv3_api.rst | 9 +-
.../userspace-api/media/dvb/headers.rst | 9 +-
.../userspace-api/media/dvb/intro.rst | 9 +-
.../media/dvb/legacy_dvb_apis.rst | 9 +-
.../userspace-api/media/dvb/net-add-if.rst | 9 +-
.../userspace-api/media/dvb/net-get-if.rst | 9 +-
.../userspace-api/media/dvb/net-remove-if.rst | 9 +-
.../userspace-api/media/dvb/net-types.rst | 9 +-
Documentation/userspace-api/media/dvb/net.rst | 9 +-
.../media/dvb/query-dvb-frontend-info.rst | 9 +-
.../media/dvb/video-clear-buffer.rst | 9 +-
.../userspace-api/media/dvb/video-command.rst | 9 +-
.../media/dvb/video-continue.rst | 9 +-
.../media/dvb/video-fast-forward.rst | 9 +-
.../userspace-api/media/dvb/video-fclose.rst | 9 +-
.../userspace-api/media/dvb/video-fopen.rst | 9 +-
.../userspace-api/media/dvb/video-freeze.rst | 9 +-
.../userspace-api/media/dvb/video-fwrite.rst | 9 +-
.../media/dvb/video-get-capabilities.rst | 9 +-
.../media/dvb/video-get-event.rst | 9 +-
.../media/dvb/video-get-frame-count.rst | 9 +-
.../userspace-api/media/dvb/video-get-pts.rst | 9 +-
.../media/dvb/video-get-size.rst | 9 +-
.../media/dvb/video-get-status.rst | 9 +-
.../userspace-api/media/dvb/video-play.rst | 9 +-
.../media/dvb/video-select-source.rst | 9 +-
.../media/dvb/video-set-blank.rst | 9 +-
.../media/dvb/video-set-display-format.rst | 9 +-
.../media/dvb/video-set-format.rst | 9 +-
.../media/dvb/video-set-streamtype.rst | 9 +-
.../media/dvb/video-slowmotion.rst | 9 +-
.../media/dvb/video-stillpicture.rst | 9 +-
.../userspace-api/media/dvb/video-stop.rst | 9 +-
.../media/dvb/video-try-command.rst | 9 +-
.../userspace-api/media/dvb/video.rst | 9 +-
.../media/dvb/video_function_calls.rst | 9 +-
.../userspace-api/media/dvb/video_types.rst | 9 +-
.../userspace-api/media/fdl-appendix.rst | 9 +-
.../userspace-api/media/gen-errors.rst | 9 +-
.../media/mediactl/media-controller-intro.rst | 9 +-
.../media/mediactl/media-controller-model.rst | 9 +-
.../media/mediactl/media-controller.rst | 9 +-
.../media/mediactl/media-func-close.rst | 9 +-
.../media/mediactl/media-func-ioctl.rst | 9 +-
.../media/mediactl/media-func-open.rst | 9 +-
.../media/mediactl/media-funcs.rst | 9 +-
.../media/mediactl/media-header.rst | 9 +-
.../media/mediactl/media-ioc-device-info.rst | 9 +-
.../mediactl/media-ioc-enum-entities.rst | 9 +-
.../media/mediactl/media-ioc-enum-links.rst | 9 +-
.../media/mediactl/media-ioc-g-topology.rst | 9 +-
.../mediactl/media-ioc-request-alloc.rst | 26 +-
.../media/mediactl/media-ioc-setup-link.rst | 9 +-
.../mediactl/media-request-ioc-queue.rst | 26 +-
.../mediactl/media-request-ioc-reinit.rst | 26 +-
.../media/mediactl/media-types.rst | 9 +-
.../media/mediactl/request-api.rst | 26 +-
.../media/mediactl/request-func-close.rst | 26 +-
.../media/mediactl/request-func-ioctl.rst | 26 +-
.../media/mediactl/request-func-poll.rst | 26 +-
.../userspace-api/media/rc/keytable.c.rst | 9 +-
.../userspace-api/media/rc/lirc-dev-intro.rst | 9 +-
.../userspace-api/media/rc/lirc-dev.rst | 9 +-
.../userspace-api/media/rc/lirc-func.rst | 9 +-
.../media/rc/lirc-get-features.rst | 9 +-
.../media/rc/lirc-get-rec-mode.rst | 9 +-
.../media/rc/lirc-get-rec-resolution.rst | 9 +-
.../media/rc/lirc-get-send-mode.rst | 9 +-
.../media/rc/lirc-get-timeout.rst | 9 +-
.../userspace-api/media/rc/lirc-header.rst | 9 +-
.../userspace-api/media/rc/lirc-read.rst | 9 +-
.../rc/lirc-set-measure-carrier-mode.rst | 9 +-
.../media/rc/lirc-set-rec-carrier-range.rst | 9 +-
.../media/rc/lirc-set-rec-carrier.rst | 9 +-
.../media/rc/lirc-set-rec-timeout-reports.rst | 9 +-
.../media/rc/lirc-set-rec-timeout.rst | 9 +-
.../media/rc/lirc-set-send-carrier.rst | 9 +-
.../media/rc/lirc-set-send-duty-cycle.rst | 9 +-
.../media/rc/lirc-set-transmitter-mask.rst | 9 +-
.../media/rc/lirc-set-wideband-receiver.rst | 9 +-
.../userspace-api/media/rc/lirc-write.rst | 9 +-
.../userspace-api/media/rc/rc-intro.rst | 9 +-
.../userspace-api/media/rc/rc-protos.rst | 4 +-
.../userspace-api/media/rc/rc-sysfs-nodes.rst | 9 +-
.../media/rc/rc-table-change.rst | 9 +-
.../userspace-api/media/rc/rc-tables.rst | 9 +-
.../media/rc/remote_controllers.rst | 9 +-
.../userspace-api/media/v4l/app-pri.rst | 9 +-
.../userspace-api/media/v4l/async.rst | 9 +-
.../userspace-api/media/v4l/audio.rst | 9 +-
.../userspace-api/media/v4l/biblio.rst | 9 +-
.../userspace-api/media/v4l/buffer.rst | 9 +-
.../media/v4l/capture-example.rst | 9 +-
.../userspace-api/media/v4l/capture.c.rst | 9 +-
.../media/v4l/colorspaces-defs.rst | 9 +-
.../media/v4l/colorspaces-details.rst | 9 +-
.../userspace-api/media/v4l/colorspaces.rst | 9 +-
.../userspace-api/media/v4l/common-defs.rst | 9 +-
.../userspace-api/media/v4l/common.rst | 9 +-
.../userspace-api/media/v4l/compat.rst | 9 +-
.../userspace-api/media/v4l/control.rst | 9 +-
.../userspace-api/media/v4l/crop.rst | 9 +-
.../userspace-api/media/v4l/depth-formats.rst | 9 +-
.../userspace-api/media/v4l/dev-capture.rst | 9 +-
.../userspace-api/media/v4l/dev-event.rst | 9 +-
.../userspace-api/media/v4l/dev-mem2mem.rst | 9 +-
.../userspace-api/media/v4l/dev-meta.rst | 9 +-
.../userspace-api/media/v4l/dev-osd.rst | 9 +-
.../userspace-api/media/v4l/dev-output.rst | 9 +-
.../userspace-api/media/v4l/dev-overlay.rst | 9 +-
.../userspace-api/media/v4l/dev-radio.rst | 9 +-
.../userspace-api/media/v4l/dev-raw-vbi.rst | 9 +-
.../userspace-api/media/v4l/dev-rds.rst | 9 +-
.../userspace-api/media/v4l/dev-sdr.rst | 9 +-
.../media/v4l/dev-sliced-vbi.rst | 9 +-
.../userspace-api/media/v4l/dev-subdev.rst | 9 +-
.../userspace-api/media/v4l/dev-touch.rst | 9 +-
.../userspace-api/media/v4l/devices.rst | 9 +-
.../userspace-api/media/v4l/diff-v4l.rst | 9 +-
.../userspace-api/media/v4l/dmabuf.rst | 9 +-
.../userspace-api/media/v4l/dv-timings.rst | 9 +-
.../media/v4l/ext-ctrls-camera.rst | 9 +-
.../media/v4l/ext-ctrls-codec.rst | 9 +-
.../media/v4l/ext-ctrls-detect.rst | 9 +-
.../userspace-api/media/v4l/ext-ctrls-dv.rst | 9 +-
.../media/v4l/ext-ctrls-flash.rst | 9 +-
.../media/v4l/ext-ctrls-fm-rx.rst | 9 +-
.../media/v4l/ext-ctrls-fm-tx.rst | 9 +-
.../media/v4l/ext-ctrls-image-process.rst | 9 +-
.../media/v4l/ext-ctrls-image-source.rst | 9 +-
.../media/v4l/ext-ctrls-jpeg.rst | 9 +-
.../media/v4l/ext-ctrls-rf-tuner.rst | 9 +-
.../media/v4l/extended-controls.rst | 9 +-
.../userspace-api/media/v4l/field-order.rst | 9 +-
.../userspace-api/media/v4l/format.rst | 9 +-
.../userspace-api/media/v4l/func-close.rst | 9 +-
.../userspace-api/media/v4l/func-ioctl.rst | 9 +-
.../userspace-api/media/v4l/func-mmap.rst | 9 +-
.../userspace-api/media/v4l/func-munmap.rst | 9 +-
.../userspace-api/media/v4l/func-open.rst | 9 +-
.../userspace-api/media/v4l/func-poll.rst | 9 +-
.../userspace-api/media/v4l/func-read.rst | 9 +-
.../userspace-api/media/v4l/func-select.rst | 9 +-
.../userspace-api/media/v4l/func-write.rst | 9 +-
.../userspace-api/media/v4l/hist-v4l2.rst | 9 +-
.../userspace-api/media/v4l/hsv-formats.rst | 9 +-
Documentation/userspace-api/media/v4l/io.rst | 9 +-
.../media/v4l/libv4l-introduction.rst | 9 +-
.../userspace-api/media/v4l/libv4l.rst | 9 +-
.../userspace-api/media/v4l/meta-formats.rst | 9 +-
.../userspace-api/media/v4l/mmap.rst | 9 +-
.../userspace-api/media/v4l/open.rst | 9 +-
.../userspace-api/media/v4l/pixfmt-bayer.rst | 9 +-
.../media/v4l/pixfmt-compressed.rst | 9 +-
.../userspace-api/media/v4l/pixfmt-grey.rst | 9 +-
.../media/v4l/pixfmt-indexed.rst | 9 +-
.../userspace-api/media/v4l/pixfmt-intro.rst | 9 +-
.../userspace-api/media/v4l/pixfmt-inzi.rst | 9 +-
.../userspace-api/media/v4l/pixfmt-m420.rst | 9 +-
.../media/v4l/pixfmt-meta-d4xx.rst | 9 +-
.../media/v4l/pixfmt-meta-intel-ipu3.rst | 25 +-
.../media/v4l/pixfmt-meta-uvc.rst | 9 +-
.../media/v4l/pixfmt-meta-vivid.rst | 26 +-
.../media/v4l/pixfmt-meta-vsp1-hgo.rst | 9 +-
.../media/v4l/pixfmt-meta-vsp1-hgt.rst | 9 +-
.../userspace-api/media/v4l/pixfmt-nv12.rst | 9 +-
.../userspace-api/media/v4l/pixfmt-nv12m.rst | 9 +-
.../userspace-api/media/v4l/pixfmt-nv12mt.rst | 9 +-
.../userspace-api/media/v4l/pixfmt-nv16.rst | 9 +-
.../userspace-api/media/v4l/pixfmt-nv16m.rst | 9 +-
.../userspace-api/media/v4l/pixfmt-nv24.rst | 9 +-
.../media/v4l/pixfmt-packed-hsv.rst | 9 +-
.../media/v4l/pixfmt-packed-yuv.rst | 9 +-
.../media/v4l/pixfmt-reserved.rst | 9 +-
.../userspace-api/media/v4l/pixfmt-rgb.rst | 9 +-
.../media/v4l/pixfmt-sdr-cs08.rst | 9 +-
.../media/v4l/pixfmt-sdr-cs14le.rst | 9 +-
.../media/v4l/pixfmt-sdr-cu08.rst | 9 +-
.../media/v4l/pixfmt-sdr-cu16le.rst | 9 +-
.../media/v4l/pixfmt-sdr-pcu16be.rst | 9 +-
.../media/v4l/pixfmt-sdr-pcu18be.rst | 9 +-
.../media/v4l/pixfmt-sdr-pcu20be.rst | 9 +-
.../media/v4l/pixfmt-sdr-ru12le.rst | 9 +-
.../media/v4l/pixfmt-srggb10-ipu3.rst | 9 +-
.../media/v4l/pixfmt-srggb10.rst | 9 +-
.../media/v4l/pixfmt-srggb10alaw8.rst | 9 +-
.../media/v4l/pixfmt-srggb10dpcm8.rst | 9 +-
.../media/v4l/pixfmt-srggb10p.rst | 9 +-
.../media/v4l/pixfmt-srggb12.rst | 9 +-
.../media/v4l/pixfmt-srggb12p.rst | 9 +-
.../media/v4l/pixfmt-srggb14.rst | 9 +-
.../media/v4l/pixfmt-srggb14p.rst | 9 +-
.../media/v4l/pixfmt-srggb16.rst | 9 +-
.../userspace-api/media/v4l/pixfmt-srggb8.rst | 9 +-
.../media/v4l/pixfmt-tch-td08.rst | 9 +-
.../media/v4l/pixfmt-tch-td16.rst | 9 +-
.../media/v4l/pixfmt-tch-tu08.rst | 9 +-
.../media/v4l/pixfmt-tch-tu16.rst | 9 +-
.../userspace-api/media/v4l/pixfmt-uv8.rst | 9 +-
.../userspace-api/media/v4l/pixfmt-uyvy.rst | 9 +-
.../media/v4l/pixfmt-v4l2-mplane.rst | 9 +-
.../userspace-api/media/v4l/pixfmt-v4l2.rst | 9 +-
.../userspace-api/media/v4l/pixfmt-vyuy.rst | 9 +-
.../userspace-api/media/v4l/pixfmt-y10.rst | 9 +-
.../userspace-api/media/v4l/pixfmt-y10b.rst | 9 +-
.../userspace-api/media/v4l/pixfmt-y10p.rst | 9 +-
.../userspace-api/media/v4l/pixfmt-y12.rst | 9 +-
.../userspace-api/media/v4l/pixfmt-y12i.rst | 9 +-
.../userspace-api/media/v4l/pixfmt-y14.rst | 9 +-
.../userspace-api/media/v4l/pixfmt-y16-be.rst | 9 +-
.../userspace-api/media/v4l/pixfmt-y16.rst | 9 +-
.../userspace-api/media/v4l/pixfmt-y41p.rst | 9 +-
.../userspace-api/media/v4l/pixfmt-y8i.rst | 9 +-
.../userspace-api/media/v4l/pixfmt-yuv410.rst | 9 +-
.../media/v4l/pixfmt-yuv411p.rst | 9 +-
.../userspace-api/media/v4l/pixfmt-yuv420.rst | 9 +-
.../media/v4l/pixfmt-yuv420m.rst | 9 +-
.../media/v4l/pixfmt-yuv422m.rst | 9 +-
.../media/v4l/pixfmt-yuv422p.rst | 9 +-
.../media/v4l/pixfmt-yuv444m.rst | 9 +-
.../userspace-api/media/v4l/pixfmt-yuyv.rst | 9 +-
.../userspace-api/media/v4l/pixfmt-yvyu.rst | 9 +-
.../userspace-api/media/v4l/pixfmt-z16.rst | 9 +-
.../userspace-api/media/v4l/pixfmt.rst | 9 +-
.../userspace-api/media/v4l/planar-apis.rst | 9 +-
.../userspace-api/media/v4l/querycap.rst | 9 +-
Documentation/userspace-api/media/v4l/rw.rst | 9 +-
.../userspace-api/media/v4l/sdr-formats.rst | 9 +-
.../media/v4l/selection-api-configuration.rst | 9 +-
.../media/v4l/selection-api-examples.rst | 9 +-
.../media/v4l/selection-api-intro.rst | 9 +-
.../media/v4l/selection-api-targets.rst | 9 +-
.../media/v4l/selection-api-vs-crop-api.rst | 9 +-
.../userspace-api/media/v4l/selection-api.rst | 9 +-
.../media/v4l/selections-common.rst | 9 +-
.../userspace-api/media/v4l/standard.rst | 9 +-
.../userspace-api/media/v4l/streaming-par.rst | 9 +-
.../media/v4l/subdev-formats.rst | 9 +-
.../userspace-api/media/v4l/tch-formats.rst | 9 +-
.../userspace-api/media/v4l/tuner.rst | 9 +-
.../userspace-api/media/v4l/user-func.rst | 9 +-
.../userspace-api/media/v4l/userp.rst | 9 +-
.../media/v4l/v4l2-selection-flags.rst | 9 +-
.../media/v4l/v4l2-selection-targets.rst | 9 +-
.../userspace-api/media/v4l/v4l2.rst | 9 +-
.../media/v4l/v4l2grab-example.rst | 9 +-
.../userspace-api/media/v4l/v4l2grab.c.rst | 9 +-
.../userspace-api/media/v4l/video.rst | 9 +-
.../userspace-api/media/v4l/videodev.rst | 9 +-
.../media/v4l/vidioc-create-bufs.rst | 9 +-
.../media/v4l/vidioc-cropcap.rst | 9 +-
.../media/v4l/vidioc-dbg-g-chip-info.rst | 9 +-
.../media/v4l/vidioc-dbg-g-register.rst | 9 +-
.../media/v4l/vidioc-decoder-cmd.rst | 9 +-
.../media/v4l/vidioc-dqevent.rst | 9 +-
.../media/v4l/vidioc-dv-timings-cap.rst | 9 +-
.../media/v4l/vidioc-encoder-cmd.rst | 9 +-
.../media/v4l/vidioc-enum-dv-timings.rst | 9 +-
.../media/v4l/vidioc-enum-fmt.rst | 9 +-
.../media/v4l/vidioc-enum-frameintervals.rst | 9 +-
.../media/v4l/vidioc-enum-framesizes.rst | 9 +-
.../media/v4l/vidioc-enum-freq-bands.rst | 9 +-
.../media/v4l/vidioc-enumaudio.rst | 9 +-
.../media/v4l/vidioc-enumaudioout.rst | 9 +-
.../media/v4l/vidioc-enuminput.rst | 9 +-
.../media/v4l/vidioc-enumoutput.rst | 9 +-
.../media/v4l/vidioc-enumstd.rst | 9 +-
.../userspace-api/media/v4l/vidioc-expbuf.rst | 9 +-
.../media/v4l/vidioc-g-audio.rst | 9 +-
.../media/v4l/vidioc-g-audioout.rst | 9 +-
.../userspace-api/media/v4l/vidioc-g-crop.rst | 9 +-
.../userspace-api/media/v4l/vidioc-g-ctrl.rst | 9 +-
.../media/v4l/vidioc-g-dv-timings.rst | 9 +-
.../userspace-api/media/v4l/vidioc-g-edid.rst | 9 +-
.../media/v4l/vidioc-g-enc-index.rst | 9 +-
.../media/v4l/vidioc-g-ext-ctrls.rst | 9 +-
.../userspace-api/media/v4l/vidioc-g-fbuf.rst | 9 +-
.../userspace-api/media/v4l/vidioc-g-fmt.rst | 9 +-
.../media/v4l/vidioc-g-frequency.rst | 9 +-
.../media/v4l/vidioc-g-input.rst | 9 +-
.../media/v4l/vidioc-g-jpegcomp.rst | 9 +-
.../media/v4l/vidioc-g-modulator.rst | 9 +-
.../media/v4l/vidioc-g-output.rst | 9 +-
.../userspace-api/media/v4l/vidioc-g-parm.rst | 9 +-
.../media/v4l/vidioc-g-priority.rst | 9 +-
.../media/v4l/vidioc-g-selection.rst | 9 +-
.../media/v4l/vidioc-g-sliced-vbi-cap.rst | 9 +-
.../userspace-api/media/v4l/vidioc-g-std.rst | 9 +-
.../media/v4l/vidioc-g-tuner.rst | 9 +-
.../media/v4l/vidioc-log-status.rst | 9 +-
.../media/v4l/vidioc-overlay.rst | 9 +-
.../media/v4l/vidioc-prepare-buf.rst | 9 +-
.../userspace-api/media/v4l/vidioc-qbuf.rst | 9 +-
.../media/v4l/vidioc-query-dv-timings.rst | 9 +-
.../media/v4l/vidioc-querybuf.rst | 9 +-
.../media/v4l/vidioc-querycap.rst | 9 +-
.../media/v4l/vidioc-queryctrl.rst | 9 +-
.../media/v4l/vidioc-querystd.rst | 9 +-
.../media/v4l/vidioc-reqbufs.rst | 9 +-
.../media/v4l/vidioc-s-hw-freq-seek.rst | 9 +-
.../media/v4l/vidioc-streamon.rst | 9 +-
.../v4l/vidioc-subdev-enum-frame-interval.rst | 9 +-
.../v4l/vidioc-subdev-enum-frame-size.rst | 9 +-
.../v4l/vidioc-subdev-enum-mbus-code.rst | 9 +-
.../media/v4l/vidioc-subdev-g-crop.rst | 9 +-
.../media/v4l/vidioc-subdev-g-fmt.rst | 9 +-
.../v4l/vidioc-subdev-g-frame-interval.rst | 9 +-
.../media/v4l/vidioc-subdev-g-selection.rst | 9 +-
.../media/v4l/vidioc-subdev-querycap.rst | 9 +-
.../media/v4l/vidioc-subscribe-event.rst | 9 +-
.../userspace-api/media/v4l/yuv-formats.rst | 9 +-
LICENSES/deprecated/GFDL-1.1+ | 366 ++++++++
LICENSES/deprecated/GFDL-1.2 | 408 +++++++++
arch/Kconfig | 2 +-
init/Kconfig | 2 +-
mm/Kconfig | 2 +-
mm/nommu.c | 2 +-
443 files changed, 1801 insertions(+), 4023 deletions(-)
rename Documentation/{nommu-mmap.txt => admin-guide/mm/nommu-mmap.rst} (100%)
rename Documentation/{bus-virt-phys-mapping.txt => core-api/bus-virt-phys-mapping.rst} (100%)
rename Documentation/{this_cpu_ops.txt => core-api/this_cpu_ops.rst} (100%)
rename Documentation/{process => core-api}/unaligned-memory-access.rst (100%)
rename Documentation/devicetree/{booting-without-of.txt => booting-without-of.rst} (90%)
rename Documentation/{mailbox.txt => driver-api/mailbox.rst} (100%)
rename Documentation/trace/{ring-buffer-design.txt => ring-buffer-design.rst} (57%)
create mode 100644 LICENSES/deprecated/GFDL-1.1+
create mode 100644 LICENSES/deprecated/GFDL-1.2
--
2.26.2
^ permalink raw reply [flat|nested] 15+ messages in thread
* [PATCH v2 1/9] docs: dt: convert booting-without-of.txt to ReST format
2020-06-23 9:52 [PATCH v2 0/9] Convert the remaining text files to ReST and add SPDX for GFDL Mauro Carvalho Chehab
@ 2020-06-23 9:52 ` Mauro Carvalho Chehab
2020-06-23 9:52 ` [PATCH v2 2/9] LICENSES: add GFDL licenses Mauro Carvalho Chehab
` (7 subsequent siblings)
8 siblings, 0 replies; 15+ messages in thread
From: Mauro Carvalho Chehab @ 2020-06-23 9:52 UTC (permalink / raw)
To: Linux Doc Mailing List
Cc: Mauro Carvalho Chehab, linux-kernel, Jonathan Corbet, Rob Herring,
Harry Wei, Alex Shi, devicetree
- Add a SPDX header;
- Adjust document title;
- Adjust document and section titles;
- Some whitespace fixes and new line breaks;
- Mark literal blocks as such;
- Add table markups;
- Add it to devicetree/index.rst.
Signed-off-by: Mauro Carvalho Chehab <mchehab+huawei@kernel.org>
---
Documentation/arm/booting.rst | 2 +-
...-without-of.txt => booting-without-of.rst} | 298 ++++++++++--------
Documentation/devicetree/index.rst | 1 +
Documentation/translations/zh_CN/arm/Booting | 2 +-
4 files changed, 168 insertions(+), 135 deletions(-)
rename Documentation/devicetree/{booting-without-of.txt => booting-without-of.rst} (90%)
diff --git a/Documentation/arm/booting.rst b/Documentation/arm/booting.rst
index 4babb6c6ae1e..a2263451dc2c 100644
--- a/Documentation/arm/booting.rst
+++ b/Documentation/arm/booting.rst
@@ -128,7 +128,7 @@ it. The recommended placement is in the first 16KiB of RAM.
The boot loader must load a device tree image (dtb) into system ram
at a 64bit aligned address and initialize it with the boot data. The
-dtb format is documented in Documentation/devicetree/booting-without-of.txt.
+dtb format is documented in Documentation/devicetree/booting-without-of.rst.
The kernel will look for the dtb magic value of 0xd00dfeed at the dtb
physical address to determine if a dtb has been passed instead of a
tagged list.
diff --git a/Documentation/devicetree/booting-without-of.txt b/Documentation/devicetree/booting-without-of.rst
similarity index 90%
rename from Documentation/devicetree/booting-without-of.txt
rename to Documentation/devicetree/booting-without-of.rst
index 4660ccee35a3..e9433350a20f 100644
--- a/Documentation/devicetree/booting-without-of.txt
+++ b/Documentation/devicetree/booting-without-of.rst
@@ -1,15 +1,19 @@
- Booting the Linux/ppc kernel without Open Firmware
- --------------------------------------------------
-
-(c) 2005 Benjamin Herrenschmidt <benh at kernel.crashing.org>,
- IBM Corp.
-(c) 2005 Becky Bruce <becky.bruce at freescale.com>,
- Freescale Semiconductor, FSL SOC and 32-bit additions
-(c) 2006 MontaVista Software, Inc.
- Flash chip node definition
-
-Table of Contents
-=================
+.. SPDX-License-Identifier: GPL-2.0
+
+==================================================
+Booting the Linux/ppc kernel without Open Firmware
+==================================================
+
+Copyright (c) 2005 Benjamin Herrenschmidt <benh at kernel.crashing.org>,
+IBM Corp.
+
+Copyright (c) 2005 Becky Bruce <becky.bruce at freescale.com>,
+Freescale Semiconductor, FSL SOC and 32-bit additions
+
+Copyright (c) 2006 MontaVista Software, Inc.
+Flash chip node definition
+
+.. Table of Contents
I - Introduction
1) Entry point for arch/arm
@@ -61,15 +65,18 @@ Table of Contents
Revision Information
====================
- May 18, 2005: Rev 0.1 - Initial draft, no chapter III yet.
+ May 18, 2005: Rev 0.1
+ - Initial draft, no chapter III yet.
- May 19, 2005: Rev 0.2 - Add chapter III and bits & pieces here or
+ May 19, 2005: Rev 0.2
+ - Add chapter III and bits & pieces here or
clarifies the fact that a lot of things are
optional, the kernel only requires a very
small device tree, though it is encouraged
to provide an as complete one as possible.
- May 24, 2005: Rev 0.3 - Precise that DT block has to be in RAM
+ May 24, 2005: Rev 0.3
+ - Precise that DT block has to be in RAM
- Misc fixes
- Define version 3 and new format version 16
for the DT block (version 16 needs kernel
@@ -82,7 +89,8 @@ Revision Information
"name" property is now automatically
deduced from the unit name
- June 1, 2005: Rev 0.4 - Correct confusion between OF_DT_END and
+ June 1, 2005: Rev 0.4
+ - Correct confusion between OF_DT_END and
OF_DT_END_NODE in structure definition.
- Change version 16 format to always align
property data to 4 bytes. Since tokens are
@@ -115,7 +123,7 @@ Revision Information
- Compare FSL SOC use of PCI to standard and make sure no new
node definition required.
- Add more information about node definitions for SOC devices
- that currently have no standard, like the FSL CPM.
+ that currently have no standard, like the FSL CPM.
I - Introduction
@@ -260,7 +268,7 @@ it with special cases.
b) create your main platform file as
"arch/powerpc/platforms/myplatform/myboard_setup.c" and add it
- to the Makefile under the condition of your CONFIG_
+ to the Makefile under the condition of your ``CONFIG_``
option. This file will define a structure of type "ppc_md"
containing the various callbacks that the generic code will
use to get to your platform specific code
@@ -271,7 +279,7 @@ it with special cases.
with classic Powerpc architectures.
3) Entry point for arch/x86
--------------------------------
+---------------------------
There is one single 32bit entry point to the kernel at code32_start,
the decompressor (the real mode entry point goes to the same 32bit
@@ -280,9 +288,9 @@ it with special cases.
Documentation/x86/boot.rst
The physical pointer to the device-tree block (defined in chapter II)
is passed via setup_data which requires at least boot protocol 2.09.
- The type filed is defined as
+ The type filed is defined as::
- #define SETUP_DTB 2
+ #define SETUP_DTB 2
This device-tree is used as an extension to the "boot page". As such it
does not parse / consider data which is already covered by the boot
@@ -354,9 +362,9 @@ the block to RAM before passing it to the kernel.
The kernel is passed the physical address pointing to an area of memory
that is roughly described in include/linux/of_fdt.h by the structure
- boot_param_header:
+ boot_param_header:::
-struct boot_param_header {
+ struct boot_param_header {
u32 magic; /* magic word OF_DT_HEADER */
u32 totalsize; /* total size of DT block */
u32 off_dt_struct; /* offset to structure */
@@ -374,19 +382,19 @@ struct boot_param_header {
/* version 17 fields below */
u32 size_dt_struct; /* size of the DT structure block */
-};
+ };
- Along with the constants:
+ Along with the constants::
-/* Definitions used by the flattened device tree */
-#define OF_DT_HEADER 0xd00dfeed /* 4: version,
- 4: total size */
-#define OF_DT_BEGIN_NODE 0x1 /* Start node: full name
- */
-#define OF_DT_END_NODE 0x2 /* End node */
-#define OF_DT_PROP 0x3 /* Property: name off,
- size, content */
-#define OF_DT_END 0x9
+ /* Definitions used by the flattened device tree */
+ #define OF_DT_HEADER 0xd00dfeed /* 4: version,
+ 4: total size */
+ #define OF_DT_BEGIN_NODE 0x1 /* Start node: full name
+ */
+ #define OF_DT_END_NODE 0x2 /* End node */
+ #define OF_DT_PROP 0x3 /* Property: name off,
+ size, content */
+ #define OF_DT_END 0x9
All values in this header are in big endian format, the various
fields in this header are defined more precisely below. All
@@ -430,7 +438,7 @@ struct boot_param_header {
way to avoid overriding critical things like, on Open Firmware
capable machines, the RTAS instance, or on some pSeries, the TCE
tables used for the iommu. Typically, the reserve map should
- contain _at least_ this DT block itself (header,total_size). If
+ contain **at least** this DT block itself (header,total_size). If
you are passing an initrd to the kernel, you should reserve it as
well. You do not need to reserve the kernel image itself. The map
should be 64-bit aligned.
@@ -485,7 +493,7 @@ struct boot_param_header {
So the typical layout of a DT block (though the various parts don't
need to be in that order) looks like this (addresses go from top to
- bottom):
+ bottom)::
------------------------------
@@ -511,9 +519,9 @@ struct boot_param_header {
|
--- (base + totalsize)
- (*) The alignment gaps are not necessarily present; their presence
- and size are dependent on the various alignment requirements of
- the individual data blocks.
+ (*) The alignment gaps are not necessarily present; their presence
+ and size are dependent on the various alignment requirements of
+ the individual data blocks.
2) Device tree generalities
@@ -600,7 +608,7 @@ discussed in a later chapter. At this point, it is only meant to give
you a idea of what a device-tree looks like. I have purposefully kept
the "name" and "linux,phandle" properties which aren't necessary in
order to give you a better idea of what the tree looks like in
-practice.
+practice::
/ o device-tree
|- name = "device-tree"
@@ -650,6 +658,7 @@ properties and their content.
3) Device tree "structure" block
+--------------------------------
The structure of the device tree is a linearized tree structure. The
"OF_DT_BEGIN_NODE" token starts a new node, and the "OF_DT_END_NODE"
@@ -666,12 +675,14 @@ Here's the basic structure of a single node:
root node)
* [align gap to next 4 bytes boundary]
* for each property:
+
* token OF_DT_PROP (that is 0x00000003)
* 32-bit value of property value size in bytes (or 0 if no
value)
* 32-bit value of offset in string block of property name
* property value data if any
* [align gap to next 4 bytes boundary]
+
* [child nodes if any]
* token OF_DT_END_NODE (that is 0x00000002)
@@ -688,6 +699,7 @@ manipulating a flattened tree must take care to preserve this
constraint.
4) Device tree "strings" block
+------------------------------
In order to save space, property names, which are generally redundant,
are stored separately in the "strings" block. This block is simply the
@@ -700,15 +712,17 @@ strings block.
III - Required content of the device tree
=========================================
-WARNING: All "linux,*" properties defined in this document apply only
-to a flattened device-tree. If your platform uses a real
-implementation of Open Firmware or an implementation compatible with
-the Open Firmware client interface, those properties will be created
-by the trampoline code in the kernel's prom_init() file. For example,
-that's where you'll have to add code to detect your board model and
-set the platform number. However, when using the flattened device-tree
-entry point, there is no prom_init() pass, and thus you have to
-provide those properties yourself.
+.. Warning::
+
+ All ``linux,*`` properties defined in this document apply only
+ to a flattened device-tree. If your platform uses a real
+ implementation of Open Firmware or an implementation compatible with
+ the Open Firmware client interface, those properties will be created
+ by the trampoline code in the kernel's prom_init() file. For example,
+ that's where you'll have to add code to detect your board model and
+ set the platform number. However, when using the flattened device-tree
+ entry point, there is no prom_init() pass, and thus you have to
+ provide those properties yourself.
1) Note about cells and address representation
@@ -769,7 +783,7 @@ addresses), all buses must contain a "ranges" property. If the
"ranges" property is missing at a given level, it's assumed that
translation isn't possible, i.e., the registers are not visible on the
parent bus. The format of the "ranges" property for a bus is a list
-of:
+of::
bus address, parent bus address, size
@@ -877,7 +891,7 @@ address which can extend beyond that limit.
This node is the parent of all individual CPU nodes. It doesn't
have any specific requirements, though it's generally good practice
- to have at least:
+ to have at least::
#address-cells = <00000001>
#size-cells = <00000000>
@@ -887,7 +901,7 @@ address which can extend beyond that limit.
that format when reading the "reg" properties of a CPU node, see
below
- c) The /cpus/* nodes
+ c) The ``/cpus/*`` nodes
So under /cpus, you are supposed to create a node for every CPU on
the machine. There is no specific restriction on the name of the
@@ -903,21 +917,23 @@ address which can extend beyond that limit.
- reg : This is the physical CPU number, it's a single 32-bit cell
and is also used as-is as the unit number for constructing the
unit name in the full path. For example, with 2 CPUs, you would
- have the full path:
+ have the full path::
+
/cpus/PowerPC,970FX@0
/cpus/PowerPC,970FX@1
+
(unit addresses do not require leading zeroes)
- - d-cache-block-size : one cell, L1 data cache block size in bytes (*)
+ - d-cache-block-size : one cell, L1 data cache block size in bytes [#]_
- i-cache-block-size : one cell, L1 instruction cache block size in
bytes
- d-cache-size : one cell, size of L1 data cache in bytes
- i-cache-size : one cell, size of L1 instruction cache in bytes
-(*) The cache "block" size is the size on which the cache management
-instructions operate. Historically, this document used the cache
-"line" size here which is incorrect. The kernel will prefer the cache
-block size and will fallback to cache line size for backward
-compatibility.
+ .. [#] The cache "block" size is the size on which the cache management
+ instructions operate. Historically, this document used the cache
+ "line" size here which is incorrect. The kernel will prefer the cache
+ block size and will fallback to cache line size for backward
+ compatibility.
Recommended properties:
@@ -963,10 +979,10 @@ compatibility.
#address-cells and #size-cells of the root node. For example,
with both of these properties being 2 like in the example given
earlier, a 970 based machine with 6Gb of RAM could typically
- have a "reg" property here that looks like:
+ have a "reg" property here that looks like::
- 00000000 00000000 00000000 80000000
- 00000001 00000000 00000001 00000000
+ 00000000 00000000 00000000 80000000
+ 00000001 00000000 00000001 00000000
That is a range starting at 0 of 0x80000000 bytes and a range
starting at 0x100000000 and of 0x100000000 bytes. You can see
@@ -1047,18 +1063,18 @@ compatibility.
See 1) above for more details on defining #address-cells.
- #size-cells : Size representation for "soc" devices
- #interrupt-cells : Defines the width of cells used to represent
- interrupts. Typically this value is <2>, which includes a
- 32-bit number that represents the interrupt number, and a
- 32-bit number that represents the interrupt sense and level.
- This field is only needed if the SOC contains an interrupt
- controller.
+ interrupts. Typically this value is <2>, which includes a
+ 32-bit number that represents the interrupt number, and a
+ 32-bit number that represents the interrupt sense and level.
+ This field is only needed if the SOC contains an interrupt
+ controller.
The SOC node may contain child nodes for each SOC device that the
platform uses. Nodes should not be created for devices which exist
on the SOC but are not used by a particular platform. See chapter VI
for more information on how to specify devices that are part of a SOC.
- Example SOC node for the MPC8540:
+ Example SOC node for the MPC8540::
soc8540@e0000000 {
#address-cells = <1>;
@@ -1079,31 +1095,33 @@ IV - "dtc", the device tree compiler
dtc source code can be found at
<http://git.jdl.com/gitweb/?p=dtc.git>
-WARNING: This version is still in early development stage; the
-resulting device-tree "blobs" have not yet been validated with the
-kernel. The current generated block lacks a useful reserve map (it will
-be fixed to generate an empty one, it's up to the bootloader to fill
-it up) among others. The error handling needs work, bugs are lurking,
-etc...
+.. Warning::
+
+ This version is still in early development stage; the
+ resulting device-tree "blobs" have not yet been validated with the
+ kernel. The current generated block lacks a useful reserve map (it will
+ be fixed to generate an empty one, it's up to the bootloader to fill
+ it up) among others. The error handling needs work, bugs are lurking,
+ etc...
dtc basically takes a device-tree in a given format and outputs a
device-tree in another format. The currently supported formats are:
- Input formats:
- -------------
+Input formats
+-------------
- "dtb": "blob" format, that is a flattened device-tree block
with
- header all in a binary blob.
+ header all in a binary blob.
- "dts": "source" format. This is a text file containing a
"source" for a device-tree. The format is defined later in this
- chapter.
+ chapter.
- "fs" format. This is a representation equivalent to the
- output of /proc/device-tree, that is nodes are directories and
- properties are files
+ output of /proc/device-tree, that is nodes are directories and
+ properties are files
- Output formats:
- ---------------
+Output formats
+--------------
- "dtb": "blob" format
- "dts": "source" format
@@ -1113,7 +1131,7 @@ device-tree in another format. The currently supported formats are:
assembly file exports some symbols that can be used.
-The syntax of the dtc tool is
+The syntax of the dtc tool is::
dtc [-I <input-format>] [-O <output-format>]
[-o output-filename] [-V output_version] input_filename
@@ -1127,43 +1145,45 @@ Additionally, dtc performs various sanity checks on the tree, like the
uniqueness of linux, phandle properties, validity of strings, etc...
The format of the .dts "source" file is "C" like, supports C and C++
-style comments.
+style comments::
-/ {
-}
+ / {
+ }
The above is the "device-tree" definition. It's the only statement
supported currently at the toplevel.
-/ {
- property1 = "string_value"; /* define a property containing a 0
- * terminated string
- */
+::
- property2 = <0x1234abcd>; /* define a property containing a
- * numerical 32-bit value (hexadecimal)
- */
+ / {
+ property1 = "string_value"; /* define a property containing a 0
+ * terminated string
+ */
- property3 = <0x12345678 0x12345678 0xdeadbeef>;
- /* define a property containing 3
- * numerical 32-bit values (cells) in
- * hexadecimal
- */
- property4 = [0x0a 0x0b 0x0c 0x0d 0xde 0xea 0xad 0xbe 0xef];
- /* define a property whose content is
- * an arbitrary array of bytes
- */
+ property2 = <0x1234abcd>; /* define a property containing a
+ * numerical 32-bit value (hexadecimal)
+ */
- childnode@address { /* define a child node named "childnode"
- * whose unit name is "childnode at
- * address"
- */
+ property3 = <0x12345678 0x12345678 0xdeadbeef>;
+ /* define a property containing 3
+ * numerical 32-bit values (cells) in
+ * hexadecimal
+ */
+ property4 = [0x0a 0x0b 0x0c 0x0d 0xde 0xea 0xad 0xbe 0xef];
+ /* define a property whose content is
+ * an arbitrary array of bytes
+ */
- childprop = "hello\n"; /* define a property "childprop" of
- * childnode (in this case, a string)
- */
- };
-};
+ childnode@address { /* define a child node named "childnode"
+ * whose unit name is "childnode at
+ * address"
+ */
+
+ childprop = "hello\n"; /* define a property "childprop" of
+ * childnode (in this case, a string)
+ */
+ };
+ };
Nodes can contain other nodes etc... thus defining the hierarchical
structure of the tree.
@@ -1322,7 +1342,7 @@ phandle of the parent node.
If the interrupt-parent property is not defined for a node, its
interrupt parent is assumed to be an ancestor in the node's
-_device tree_ hierarchy.
+*device tree* hierarchy.
3) OpenPIC Interrupt Controllers
--------------------------------
@@ -1334,10 +1354,12 @@ information.
Sense and level information should be encoded as follows:
- 0 = low to high edge sensitive type enabled
- 1 = active low level sensitive type enabled
- 2 = active high level sensitive type enabled
- 3 = high to low edge sensitive type enabled
+ == ========================================
+ 0 low to high edge sensitive type enabled
+ 1 active low level sensitive type enabled
+ 2 active high level sensitive type enabled
+ 3 high to low edge sensitive type enabled
+ == ========================================
4) ISA Interrupt Controllers
----------------------------
@@ -1350,13 +1372,15 @@ information.
ISA PIC interrupt controllers should adhere to the ISA PIC
encodings listed below:
- 0 = active low level sensitive type enabled
- 1 = active high level sensitive type enabled
- 2 = high to low edge sensitive type enabled
- 3 = low to high edge sensitive type enabled
+ == ========================================
+ 0 active low level sensitive type enabled
+ 1 active high level sensitive type enabled
+ 2 high to low edge sensitive type enabled
+ 3 low to high edge sensitive type enabled
+ == ========================================
VIII - Specifying Device Power Management Information (sleep property)
-===================================================================
+======================================================================
Devices on SOCs often have mechanisms for placing devices into low-power
states that are decoupled from the devices' own register blocks. Sometimes,
@@ -1387,6 +1411,7 @@ reasonably grouped in this manner, then create a virtual sleep controller
sleep-map should wait until its necessity is demonstrated).
IX - Specifying dma bus information
+===================================
Some devices may have DMA memory range shifted relatively to the beginning of
RAM, or even placed outside of kernel RAM. For example, the Keystone 2 SoC
@@ -1404,25 +1429,30 @@ coherent DMA operations. The "dma-coherent" property is intended to be used
for identifying devices supported coherent DMA operations in DT.
* DMA Bus master
+
Optional property:
+
- dma-ranges: <prop-encoded-array> encoded as arbitrary number of triplets of
- (child-bus-address, parent-bus-address, length). Each triplet specified
- describes a contiguous DMA address range.
- The dma-ranges property is used to describe the direct memory access (DMA)
- structure of a memory-mapped bus whose device tree parent can be accessed
- from DMA operations originating from the bus. It provides a means of
- defining a mapping or translation between the physical address space of
- the bus and the physical address space of the parent of the bus.
- (for more information see the Devicetree Specification)
+ (child-bus-address, parent-bus-address, length). Each triplet specified
+ describes a contiguous DMA address range.
+ The dma-ranges property is used to describe the direct memory access (DMA)
+ structure of a memory-mapped bus whose device tree parent can be accessed
+ from DMA operations originating from the bus. It provides a means of
+ defining a mapping or translation between the physical address space of
+ the bus and the physical address space of the parent of the bus.
+ (for more information see the Devicetree Specification)
* DMA Bus child
+
Optional property:
+
- dma-ranges: <empty> value. if present - It means that DMA addresses
- translation has to be enabled for this device.
+ translation has to be enabled for this device.
- dma-coherent: Present if dma operations are coherent
-Example:
-soc {
+Example::
+
+ soc {
compatible = "ti,keystone","simple-bus";
ranges = <0x0 0x0 0x0 0xc0000000>;
dma-ranges = <0x80000000 0x8 0x00000000 0x80000000>;
@@ -1435,11 +1465,13 @@ soc {
[...]
dma-coherent;
};
-};
+ };
Appendix A - Sample SOC node for MPC8540
========================================
+::
+
soc@e0000000 {
#address-cells = <1>;
#size-cells = <1>;
diff --git a/Documentation/devicetree/index.rst b/Documentation/devicetree/index.rst
index 54026763916d..d2a96e1af23e 100644
--- a/Documentation/devicetree/index.rst
+++ b/Documentation/devicetree/index.rst
@@ -15,3 +15,4 @@ Open Firmware and Device Tree
overlay-notes
bindings/index
+ booting-without-of
diff --git a/Documentation/translations/zh_CN/arm/Booting b/Documentation/translations/zh_CN/arm/Booting
index 562e9a2957e6..c3d26ce5f6de 100644
--- a/Documentation/translations/zh_CN/arm/Booting
+++ b/Documentation/translations/zh_CN/arm/Booting
@@ -124,7 +124,7 @@ bootloader 必须传递一个系统内存的位置和最小值，以及根文件
bootloader 必须以 64bit 地址对齐的形式加载一个设备树映像(dtb)到系统
RAM 中，并用启动数据初始化它。dtb 格式在文档
-Documentation/devicetree/booting-without-of.txt 中。内核将会在
+Documentation/devicetree/booting-without-of.rst 中。内核将会在
dtb 物理地址处查找 dtb 魔数值（0xd00dfeed），以确定 dtb 是否已经代替
标签列表被传递进来。
--
2.26.2
^ permalink raw reply related [flat|nested] 15+ messages in thread
* [PATCH v2 2/9] LICENSES: add GFDL licenses
2020-06-23 9:52 [PATCH v2 0/9] Convert the remaining text files to ReST and add SPDX for GFDL Mauro Carvalho Chehab
2020-06-23 9:52 ` [PATCH v2 1/9] docs: dt: convert booting-without-of.txt to ReST format Mauro Carvalho Chehab
@ 2020-06-23 9:52 ` Mauro Carvalho Chehab
2020-06-23 11:47 ` Kate Stewart
2020-06-23 9:52 ` [PATCH v2 4/9] docs: trace: ring-buffer-design.txt: convert to ReST format Mauro Carvalho Chehab
` (6 subsequent siblings)
8 siblings, 1 reply; 15+ messages in thread
From: Mauro Carvalho Chehab @ 2020-06-23 9:52 UTC (permalink / raw)
To: Linux Doc Mailing List
Cc: Mauro Carvalho Chehab, linux-kernel, Jonathan Corbet,
Thomas Gleixner, Greg Kroah-Hartman, linux-spdx
Those are used on some documentation texts.
Signed-off-by: Mauro Carvalho Chehab <mchehab+huawei@kernel.org>
---
LICENSES/deprecated/GFDL-1.1+ | 366 ++++++++++++++++++++++++++++++
LICENSES/deprecated/GFDL-1.2 | 408 ++++++++++++++++++++++++++++++++++
2 files changed, 774 insertions(+)
create mode 100644 LICENSES/deprecated/GFDL-1.1+
create mode 100644 LICENSES/deprecated/GFDL-1.2
diff --git a/LICENSES/deprecated/GFDL-1.1+ b/LICENSES/deprecated/GFDL-1.1+
new file mode 100644
index 000000000000..f65e4fcdc520
--- /dev/null
+++ b/LICENSES/deprecated/GFDL-1.1+
@@ -0,0 +1,366 @@
+Valid-License-Identifier: GFDL-1.1-or-later-no-invariants
+SPDX-URL: https://github.com/spdx/license-list-XML/pull/1048/commits/f695d2ac65230d0f4161ba58fff2f9d87bb5a053#diff-b948674e5c5cf6341e44e76b2565e80c
+Usage-Guide:
+ The GNU Free Documentation License with no Invariant Sections,
+ no Front-Cover Texts, and no Back-Cover Texts should not be used in new
+ code, except when dual-licensed with GPLv2.
+ To use the license in source code, put the following SPDX tag/value pair
+ into a comment according to the placement guidelines in the licensing
+ rules documentation:
+ SPDX-License-Identifier: GFDL-1.1-or-later-no-invariants
+License-Text:
+ GNU Free Documentation License
+ Version 1.1, March 2000
+
+ Copyright (C) 2000 Free Software Foundation, Inc.
+ 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
+ Everyone is permitted to copy and distribute verbatim copies
+ of this license document, but changing it is not allowed.
+
+
+0. PREAMBLE
+
+The purpose of this License is to make a manual, textbook, or other
+written document "free" in the sense of freedom: to assure everyone
+the effective freedom to copy and redistribute it, with or without
+modifying it, either commercially or noncommercially. Secondarily,
+this License preserves for the author and publisher a way to get
+credit for their work, while not being considered responsible for
+modifications made by others.
+
+This License is a kind of "copyleft", which means that derivative
+works of the document must themselves be free in the same sense. It
+complements the GNU General Public License, which is a copyleft
+license designed for free software.
+
+We have designed this License in order to use it for manuals for free
+software, because free software needs free documentation: a free
+program should come with manuals providing the same freedoms that the
+software does. But this License is not limited to software manuals;
+it can be used for any textual work, regardless of subject matter or
+whether it is published as a printed book. We recommend this License
+principally for works whose purpose is instruction or reference.
+
+
+1. APPLICABILITY AND DEFINITIONS
+
+This License applies to any manual or other work that contains a
+notice placed by the copyright holder saying it can be distributed
+under the terms of this License. The "Document", below, refers to any
+such manual or work. Any member of the public is a licensee, and is
+addressed as "you".
+
+A "Modified Version" of the Document means any work containing the
+Document or a portion of it, either copied verbatim, or with
+modifications and/or translated into another language.
+
+A "Secondary Section" is a named appendix or a front-matter section of
+the Document that deals exclusively with the relationship of the
+publishers or authors of the Document to the Document's overall subject
+(or to related matters) and contains nothing that could fall directly
+within that overall subject. (For example, if the Document is in part a
+textbook of mathematics, a Secondary Section may not explain any
+mathematics.) The relationship could be a matter of historical
+connection with the subject or with related matters, or of legal,
+commercial, philosophical, ethical or political position regarding
+them.
+
+The "Invariant Sections" are certain Secondary Sections whose titles
+are designated, as being those of Invariant Sections, in the notice
+that says that the Document is released under this License.
+
+The "Cover Texts" are certain short passages of text that are listed,
+as Front-Cover Texts or Back-Cover Texts, in the notice that says that
+the Document is released under this License.
+
+A "Transparent" copy of the Document means a machine-readable copy,
+represented in a format whose specification is available to the
+general public, whose contents can be viewed and edited directly and
+straightforwardly with generic text editors or (for images composed of
+pixels) generic paint programs or (for drawings) some widely available
+drawing editor, and that is suitable for input to text formatters or
+for automatic translation to a variety of formats suitable for input
+to text formatters. A copy made in an otherwise Transparent file
+format whose markup has been designed to thwart or discourage
+subsequent modification by readers is not Transparent. A copy that is
+not "Transparent" is called "Opaque".
+
+Examples of suitable formats for Transparent copies include plain
+ASCII without markup, Texinfo input format, LaTeX input format, SGML
+or XML using a publicly available DTD, and standard-conforming simple
+HTML designed for human modification. Opaque formats include
+PostScript, PDF, proprietary formats that can be read and edited only
+by proprietary word processors, SGML or XML for which the DTD and/or
+processing tools are not generally available, and the
+machine-generated HTML produced by some word processors for output
+purposes only.
+
+The "Title Page" means, for a printed book, the title page itself,
+plus such following pages as are needed to hold, legibly, the material
+this License requires to appear in the title page. For works in
+formats which do not have any title page as such, "Title Page" means
+the text near the most prominent appearance of the work's title,
+preceding the beginning of the body of the text.
+
+
+2. VERBATIM COPYING
+
+You may copy and distribute the Document in any medium, either
+commercially or noncommercially, provided that this License, the
+copyright notices, and the license notice saying this License applies
+to the Document are reproduced in all copies, and that you add no other
+conditions whatsoever to those of this License. You may not use
+technical measures to obstruct or control the reading or further
+copying of the copies you make or distribute. However, you may accept
+compensation in exchange for copies. If you distribute a large enough
+number of copies you must also follow the conditions in section 3.
+
+You may also lend copies, under the same conditions stated above, and
+you may publicly display copies.
+
+
+3. COPYING IN QUANTITY
+
+If you publish printed copies of the Document numbering more than 100,
+and the Document's license notice requires Cover Texts, you must enclose
+the copies in covers that carry, clearly and legibly, all these Cover
+Texts: Front-Cover Texts on the front cover, and Back-Cover Texts on
+the back cover. Both covers must also clearly and legibly identify
+you as the publisher of these copies. The front cover must present
+the full title with all words of the title equally prominent and
+visible. You may add other material on the covers in addition.
+Copying with changes limited to the covers, as long as they preserve
+the title of the Document and satisfy these conditions, can be treated
+as verbatim copying in other respects.
+
+If the required texts for either cover are too voluminous to fit
+legibly, you should put the first ones listed (as many as fit
+reasonably) on the actual cover, and continue the rest onto adjacent
+pages.
+
+If you publish or distribute Opaque copies of the Document numbering
+more than 100, you must either include a machine-readable Transparent
+copy along with each Opaque copy, or state in or with each Opaque copy
+a publicly-accessible computer-network location containing a complete
+Transparent copy of the Document, free of added material, which the
+general network-using public has access to download anonymously at no
+charge using public-standard network protocols. If you use the latter
+option, you must take reasonably prudent steps, when you begin
+distribution of Opaque copies in quantity, to ensure that this
+Transparent copy will remain thus accessible at the stated location
+until at least one year after the last time you distribute an Opaque
+copy (directly or through your agents or retailers) of that edition to
+the public.
+
+It is requested, but not required, that you contact the authors of the
+Document well before redistributing any large number of copies, to give
+them a chance to provide you with an updated version of the Document.
+
+
+4. MODIFICATIONS
+
+You may copy and distribute a Modified Version of the Document under
+the conditions of sections 2 and 3 above, provided that you release
+the Modified Version under precisely this License, with the Modified
+Version filling the role of the Document, thus licensing distribution
+and modification of the Modified Version to whoever possesses a copy
+of it. In addition, you must do these things in the Modified Version:
+
+A. Use in the Title Page (and on the covers, if any) a title distinct
+ from that of the Document, and from those of previous versions
+ (which should, if there were any, be listed in the History section
+ of the Document). You may use the same title as a previous version
+ if the original publisher of that version gives permission.
+B. List on the Title Page, as authors, one or more persons or entities
+ responsible for authorship of the modifications in the Modified
+ Version, together with at least five of the principal authors of the
+ Document (all of its principal authors, if it has less than five).
+C. State on the Title page the name of the publisher of the
+ Modified Version, as the publisher.
+D. Preserve all the copyright notices of the Document.
+E. Add an appropriate copyright notice for your modifications
+ adjacent to the other copyright notices.
+F. Include, immediately after the copyright notices, a license notice
+ giving the public permission to use the Modified Version under the
+ terms of this License, in the form shown in the Addendum below.
+G. Preserve in that license notice the full lists of Invariant Sections
+ and required Cover Texts given in the Document's license notice.
+H. Include an unaltered copy of this License.
+I. Preserve the section entitled "History", and its title, and add to
+ it an item stating at least the title, year, new authors, and
+ publisher of the Modified Version as given on the Title Page. If
+ there is no section entitled "History" in the Document, create one
+ stating the title, year, authors, and publisher of the Document as
+ given on its Title Page, then add an item describing the Modified
+ Version as stated in the previous sentence.
+J. Preserve the network location, if any, given in the Document for
+ public access to a Transparent copy of the Document, and likewise
+ the network locations given in the Document for previous versions
+ it was based on. These may be placed in the "History" section.
+ You may omit a network location for a work that was published at
+ least four years before the Document itself, or if the original
+ publisher of the version it refers to gives permission.
+K. In any section entitled "Acknowledgements" or "Dedications",
+ preserve the section's title, and preserve in the section all the
+ substance and tone of each of the contributor acknowledgements
+ and/or dedications given therein.
+L. Preserve all the Invariant Sections of the Document,
+ unaltered in their text and in their titles. Section numbers
+ or the equivalent are not considered part of the section titles.
+M. Delete any section entitled "Endorsements". Such a section
+ may not be included in the Modified Version.
+N. Do not retitle any existing section as "Endorsements"
+ or to conflict in title with any Invariant Section.
+
+If the Modified Version includes new front-matter sections or
+appendices that qualify as Secondary Sections and contain no material
+copied from the Document, you may at your option designate some or all
+of these sections as invariant. To do this, add their titles to the
+list of Invariant Sections in the Modified Version's license notice.
+These titles must be distinct from any other section titles.
+
+You may add a section entitled "Endorsements", provided it contains
+nothing but endorsements of your Modified Version by various
+parties--for example, statements of peer review or that the text has
+been approved by an organization as the authoritative definition of a
+standard.
+
+You may add a passage of up to five words as a Front-Cover Text, and a
+passage of up to 25 words as a Back-Cover Text, to the end of the list
+of Cover Texts in the Modified Version. Only one passage of
+Front-Cover Text and one of Back-Cover Text may be added by (or
+through arrangements made by) any one entity. If the Document already
+includes a cover text for the same cover, previously added by you or
+by arrangement made by the same entity you are acting on behalf of,
+you may not add another; but you may replace the old one, on explicit
+permission from the previous publisher that added the old one.
+
+The author(s) and publisher(s) of the Document do not by this License
+give permission to use their names for publicity for or to assert or
+imply endorsement of any Modified Version.
+
+
+5. COMBINING DOCUMENTS
+
+You may combine the Document with other documents released under this
+License, under the terms defined in section 4 above for modified
+versions, provided that you include in the combination all of the
+Invariant Sections of all of the original documents, unmodified, and
+list them all as Invariant Sections of your combined work in its
+license notice.
+
+The combined work need only contain one copy of this License, and
+multiple identical Invariant Sections may be replaced with a single
+copy. If there are multiple Invariant Sections with the same name but
+different contents, make the title of each such section unique by
+adding at the end of it, in parentheses, the name of the original
+author or publisher of that section if known, or else a unique number.
+Make the same adjustment to the section titles in the list of
+Invariant Sections in the license notice of the combined work.
+
+In the combination, you must combine any sections entitled "History"
+in the various original documents, forming one section entitled
+"History"; likewise combine any sections entitled "Acknowledgements",
+and any sections entitled "Dedications". You must delete all sections
+entitled "Endorsements."
+
+
+6. COLLECTIONS OF DOCUMENTS
+
+You may make a collection consisting of the Document and other documents
+released under this License, and replace the individual copies of this
+License in the various documents with a single copy that is included in
+the collection, provided that you follow the rules of this License for
+verbatim copying of each of the documents in all other respects.
+
+You may extract a single document from such a collection, and distribute
+it individually under this License, provided you insert a copy of this
+License into the extracted document, and follow this License in all
+other respects regarding verbatim copying of that document.
+
+
+7. AGGREGATION WITH INDEPENDENT WORKS
+
+A compilation of the Document or its derivatives with other separate
+and independent documents or works, in or on a volume of a storage or
+distribution medium, does not as a whole count as a Modified Version
+of the Document, provided no compilation copyright is claimed for the
+compilation. Such a compilation is called an "aggregate", and this
+License does not apply to the other self-contained works thus compiled
+with the Document, on account of their being thus compiled, if they
+are not themselves derivative works of the Document.
+
+If the Cover Text requirement of section 3 is applicable to these
+copies of the Document, then if the Document is less than one quarter
+of the entire aggregate, the Document's Cover Texts may be placed on
+covers that surround only the Document within the aggregate.
+Otherwise they must appear on covers around the whole aggregate.
+
+
+8. TRANSLATION
+
+Translation is considered a kind of modification, so you may
+distribute translations of the Document under the terms of section 4.
+Replacing Invariant Sections with translations requires special
+permission from their copyright holders, but you may include
+translations of some or all Invariant Sections in addition to the
+original versions of these Invariant Sections. You may include a
+translation of this License provided that you also include the
+original English version of this License. In case of a disagreement
+between the translation and the original English version of this
+License, the original English version will prevail.
+
+
+9. TERMINATION
+
+You may not copy, modify, sublicense, or distribute the Document except
+as expressly provided for under this License. Any other attempt to
+copy, modify, sublicense or distribute the Document is void, and will
+automatically terminate your rights under this License. However,
+parties who have received copies, or rights, from you under this
+License will not have their licenses terminated so long as such
+parties remain in full compliance.
+
+
+10. FUTURE REVISIONS OF THIS LICENSE
+
+The Free Software Foundation may publish new, revised versions
+of the GNU Free Documentation License from time to time. Such new
+versions will be similar in spirit to the present version, but may
+differ in detail to address new problems or concerns. See
+https://www.gnu.org/licenses/.
+
+Each version of the License is given a distinguishing version number.
+If the Document specifies that a particular numbered version of this
+License "or any later version" applies to it, you have the option of
+following the terms and conditions either of that specified version or
+of any later version that has been published (not as a draft) by the
+Free Software Foundation. If the Document does not specify a version
+number of this License, you may choose any version ever published (not
+as a draft) by the Free Software Foundation.
+
+
+ADDENDUM: How to use this License for your documents
+
+To use this License in a document you have written, include a copy of
+the License in the document and put the following copyright and
+license notices just after the title page:
+
+ Copyright (c) YEAR YOUR NAME.
+ Permission is granted to copy, distribute and/or modify this document
+ under the terms of the GNU Free Documentation License, Version 1.1
+ or any later version published by the Free Software Foundation;
+ with the Invariant Sections being LIST THEIR TITLES, with the
+ Front-Cover Texts being LIST, and with the Back-Cover Texts being LIST.
+ A copy of the license is included in the section entitled "GNU
+ Free Documentation License".
+
+If you have no Invariant Sections, write "with no Invariant Sections"
+instead of saying which ones are invariant. If you have no
+Front-Cover Texts, write "no Front-Cover Texts" instead of
+"Front-Cover Texts being LIST"; likewise for Back-Cover Texts.
+
+If your document contains nontrivial examples of program code, we
+recommend releasing these examples in parallel under your choice of
+free software license, such as the GNU General Public License,
+to permit their use in free software.
diff --git a/LICENSES/deprecated/GFDL-1.2 b/LICENSES/deprecated/GFDL-1.2
new file mode 100644
index 000000000000..760b2568fde5
--- /dev/null
+++ b/LICENSES/deprecated/GFDL-1.2
@@ -0,0 +1,408 @@
+Valid-License-Identifier: GFDL-1.2-only-no-invariants
+SPDX-URL: https://github.com/spdx/license-list-XML/pull/1048/commits/f695d2ac65230d0f4161ba58fff2f9d87bb5a053#diff-b948674e5c5cf6341e44e76b2565e80c
+Usage-Guide:
+ The GNU Free Documentation License with no Invariant Sections,
+ no Front-Cover Texts, and no Back-Cover Texts should not be used in new
+ code, except when dual-licensed with GPLv2.
+ To use the license in source code, put the following SPDX tag/value pair
+ into a comment according to the placement guidelines in the licensing
+ rules documentation:
+ SPDX-License-Identifier: GFDL-1.2-only-no-invariants
+License-Text:
+ GNU Free Documentation License
+ Version 1.2, November 2002
+
+
+ Copyright (C) 2000,2001,2002 Free Software Foundation, Inc.
+ 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
+ Everyone is permitted to copy and distribute verbatim copies
+ of this license document, but changing it is not allowed.
+
+
+0. PREAMBLE
+
+The purpose of this License is to make a manual, textbook, or other
+functional and useful document "free" in the sense of freedom: to
+assure everyone the effective freedom to copy and redistribute it,
+with or without modifying it, either commercially or noncommercially.
+Secondarily, this License preserves for the author and publisher a way
+to get credit for their work, while not being considered responsible
+for modifications made by others.
+
+This License is a kind of "copyleft", which means that derivative
+works of the document must themselves be free in the same sense. It
+complements the GNU General Public License, which is a copyleft
+license designed for free software.
+
+We have designed this License in order to use it for manuals for free
+software, because free software needs free documentation: a free
+program should come with manuals providing the same freedoms that the
+software does. But this License is not limited to software manuals;
+it can be used for any textual work, regardless of subject matter or
+whether it is published as a printed book. We recommend this License
+principally for works whose purpose is instruction or reference.
+
+
+1. APPLICABILITY AND DEFINITIONS
+
+This License applies to any manual or other work, in any medium, that
+contains a notice placed by the copyright holder saying it can be
+distributed under the terms of this License. Such a notice grants a
+world-wide, royalty-free license, unlimited in duration, to use that
+work under the conditions stated herein. The "Document", below,
+refers to any such manual or work. Any member of the public is a
+licensee, and is addressed as "you". You accept the license if you
+copy, modify or distribute the work in a way requiring permission
+under copyright law.
+
+A "Modified Version" of the Document means any work containing the
+Document or a portion of it, either copied verbatim, or with
+modifications and/or translated into another language.
+
+A "Secondary Section" is a named appendix or a front-matter section of
+the Document that deals exclusively with the relationship of the
+publishers or authors of the Document to the Document's overall subject
+(or to related matters) and contains nothing that could fall directly
+within that overall subject. (Thus, if the Document is in part a
+textbook of mathematics, a Secondary Section may not explain any
+mathematics.) The relationship could be a matter of historical
+connection with the subject or with related matters, or of legal,
+commercial, philosophical, ethical or political position regarding
+them.
+
+The "Invariant Sections" are certain Secondary Sections whose titles
+are designated, as being those of Invariant Sections, in the notice
+that says that the Document is released under this License. If a
+section does not fit the above definition of Secondary then it is not
+allowed to be designated as Invariant. The Document may contain zero
+Invariant Sections. If the Document does not identify any Invariant
+Sections then there are none.
+
+The "Cover Texts" are certain short passages of text that are listed,
+as Front-Cover Texts or Back-Cover Texts, in the notice that says that
+the Document is released under this License. A Front-Cover Text may
+be at most 5 words, and a Back-Cover Text may be at most 25 words.
+
+A "Transparent" copy of the Document means a machine-readable copy,
+represented in a format whose specification is available to the
+general public, that is suitable for revising the document
+straightforwardly with generic text editors or (for images composed of
+pixels) generic paint programs or (for drawings) some widely available
+drawing editor, and that is suitable for input to text formatters or
+for automatic translation to a variety of formats suitable for input
+to text formatters. A copy made in an otherwise Transparent file
+format whose markup, or absence of markup, has been arranged to thwart
+or discourage subsequent modification by readers is not Transparent.
+An image format is not Transparent if used for any substantial amount
+of text. A copy that is not "Transparent" is called "Opaque".
+
+Examples of suitable formats for Transparent copies include plain
+ASCII without markup, Texinfo input format, LaTeX input format, SGML
+or XML using a publicly available DTD, and standard-conforming simple
+HTML, PostScript or PDF designed for human modification. Examples of
+transparent image formats include PNG, XCF and JPG. Opaque formats
+include proprietary formats that can be read and edited only by
+proprietary word processors, SGML or XML for which the DTD and/or
+processing tools are not generally available, and the
+machine-generated HTML, PostScript or PDF produced by some word
+processors for output purposes only.
+
+The "Title Page" means, for a printed book, the title page itself,
+plus such following pages as are needed to hold, legibly, the material
+this License requires to appear in the title page. For works in
+formats which do not have any title page as such, "Title Page" means
+the text near the most prominent appearance of the work's title,
+preceding the beginning of the body of the text.
+
+A section "Entitled XYZ" means a named subunit of the Document whose
+title either is precisely XYZ or contains XYZ in parentheses following
+text that translates XYZ in another language. (Here XYZ stands for a
+specific section name mentioned below, such as "Acknowledgements",
+"Dedications", "Endorsements", or "History".) To "Preserve the Title"
+of such a section when you modify the Document means that it remains a
+section "Entitled XYZ" according to this definition.
+
+The Document may include Warranty Disclaimers next to the notice which
+states that this License applies to the Document. These Warranty
+Disclaimers are considered to be included by reference in this
+License, but only as regards disclaiming warranties: any other
+implication that these Warranty Disclaimers may have is void and has
+no effect on the meaning of this License.
+
+
+2. VERBATIM COPYING
+
+You may copy and distribute the Document in any medium, either
+commercially or noncommercially, provided that this License, the
+copyright notices, and the license notice saying this License applies
+to the Document are reproduced in all copies, and that you add no other
+conditions whatsoever to those of this License. You may not use
+technical measures to obstruct or control the reading or further
+copying of the copies you make or distribute. However, you may accept
+compensation in exchange for copies. If you distribute a large enough
+number of copies you must also follow the conditions in section 3.
+
+You may also lend copies, under the same conditions stated above, and
+you may publicly display copies.
+
+
+3. COPYING IN QUANTITY
+
+If you publish printed copies (or copies in media that commonly have
+printed covers) of the Document, numbering more than 100, and the
+Document's license notice requires Cover Texts, you must enclose the
+copies in covers that carry, clearly and legibly, all these Cover
+Texts: Front-Cover Texts on the front cover, and Back-Cover Texts on
+the back cover. Both covers must also clearly and legibly identify
+you as the publisher of these copies. The front cover must present
+the full title with all words of the title equally prominent and
+visible. You may add other material on the covers in addition.
+Copying with changes limited to the covers, as long as they preserve
+the title of the Document and satisfy these conditions, can be treated
+as verbatim copying in other respects.
+
+If the required texts for either cover are too voluminous to fit
+legibly, you should put the first ones listed (as many as fit
+reasonably) on the actual cover, and continue the rest onto adjacent
+pages.
+
+If you publish or distribute Opaque copies of the Document numbering
+more than 100, you must either include a machine-readable Transparent
+copy along with each Opaque copy, or state in or with each Opaque copy
+a computer-network location from which the general network-using
+public has access to download using public-standard network protocols
+a complete Transparent copy of the Document, free of added material.
+If you use the latter option, you must take reasonably prudent steps,
+when you begin distribution of Opaque copies in quantity, to ensure
+that this Transparent copy will remain thus accessible at the stated
+location until at least one year after the last time you distribute an
+Opaque copy (directly or through your agents or retailers) of that
+edition to the public.
+
+It is requested, but not required, that you contact the authors of the
+Document well before redistributing any large number of copies, to give
+them a chance to provide you with an updated version of the Document.
+
+
+4. MODIFICATIONS
+
+You may copy and distribute a Modified Version of the Document under
+the conditions of sections 2 and 3 above, provided that you release
+the Modified Version under precisely this License, with the Modified
+Version filling the role of the Document, thus licensing distribution
+and modification of the Modified Version to whoever possesses a copy
+of it. In addition, you must do these things in the Modified Version:
+
+A. Use in the Title Page (and on the covers, if any) a title distinct
+ from that of the Document, and from those of previous versions
+ (which should, if there were any, be listed in the History section
+ of the Document). You may use the same title as a previous version
+ if the original publisher of that version gives permission.
+B. List on the Title Page, as authors, one or more persons or entities
+ responsible for authorship of the modifications in the Modified
+ Version, together with at least five of the principal authors of the
+ Document (all of its principal authors, if it has fewer than five),
+ unless they release you from this requirement.
+C. State on the Title page the name of the publisher of the
+ Modified Version, as the publisher.
+D. Preserve all the copyright notices of the Document.
+E. Add an appropriate copyright notice for your modifications
+ adjacent to the other copyright notices.
+F. Include, immediately after the copyright notices, a license notice
+ giving the public permission to use the Modified Version under the
+ terms of this License, in the form shown in the Addendum below.
+G. Preserve in that license notice the full lists of Invariant Sections
+ and required Cover Texts given in the Document's license notice.
+H. Include an unaltered copy of this License.
+I. Preserve the section Entitled "History", Preserve its Title, and add
+ to it an item stating at least the title, year, new authors, and
+ publisher of the Modified Version as given on the Title Page. If
+ there is no section Entitled "History" in the Document, create one
+ stating the title, year, authors, and publisher of the Document as
+ given on its Title Page, then add an item describing the Modified
+ Version as stated in the previous sentence.
+J. Preserve the network location, if any, given in the Document for
+ public access to a Transparent copy of the Document, and likewise
+ the network locations given in the Document for previous versions
+ it was based on. These may be placed in the "History" section.
+ You may omit a network location for a work that was published at
+ least four years before the Document itself, or if the original
+ publisher of the version it refers to gives permission.
+K. For any section Entitled "Acknowledgements" or "Dedications",
+ Preserve the Title of the section, and preserve in the section all
+ the substance and tone of each of the contributor acknowledgements
+ and/or dedications given therein.
+L. Preserve all the Invariant Sections of the Document,
+ unaltered in their text and in their titles. Section numbers
+ or the equivalent are not considered part of the section titles.
+M. Delete any section Entitled "Endorsements". Such a section
+ may not be included in the Modified Version.
+N. Do not retitle any existing section to be Entitled "Endorsements"
+ or to conflict in title with any Invariant Section.
+O. Preserve any Warranty Disclaimers.
+
+If the Modified Version includes new front-matter sections or
+appendices that qualify as Secondary Sections and contain no material
+copied from the Document, you may at your option designate some or all
+of these sections as invariant. To do this, add their titles to the
+list of Invariant Sections in the Modified Version's license notice.
+These titles must be distinct from any other section titles.
+
+You may add a section Entitled "Endorsements", provided it contains
+nothing but endorsements of your Modified Version by various
+parties--for example, statements of peer review or that the text has
+been approved by an organization as the authoritative definition of a
+standard.
+
+You may add a passage of up to five words as a Front-Cover Text, and a
+passage of up to 25 words as a Back-Cover Text, to the end of the list
+of Cover Texts in the Modified Version. Only one passage of
+Front-Cover Text and one of Back-Cover Text may be added by (or
+through arrangements made by) any one entity. If the Document already
+includes a cover text for the same cover, previously added by you or
+by arrangement made by the same entity you are acting on behalf of,
+you may not add another; but you may replace the old one, on explicit
+permission from the previous publisher that added the old one.
+
+The author(s) and publisher(s) of the Document do not by this License
+give permission to use their names for publicity for or to assert or
+imply endorsement of any Modified Version.
+
+
+5. COMBINING DOCUMENTS
+
+You may combine the Document with other documents released under this
+License, under the terms defined in section 4 above for modified
+versions, provided that you include in the combination all of the
+Invariant Sections of all of the original documents, unmodified, and
+list them all as Invariant Sections of your combined work in its
+license notice, and that you preserve all their Warranty Disclaimers.
+
+The combined work need only contain one copy of this License, and
+multiple identical Invariant Sections may be replaced with a single
+copy. If there are multiple Invariant Sections with the same name but
+different contents, make the title of each such section unique by
+adding at the end of it, in parentheses, the name of the original
+author or publisher of that section if known, or else a unique number.
+Make the same adjustment to the section titles in the list of
+Invariant Sections in the license notice of the combined work.
+
+In the combination, you must combine any sections Entitled "History"
+in the various original documents, forming one section Entitled
+"History"; likewise combine any sections Entitled "Acknowledgements",
+and any sections Entitled "Dedications". You must delete all sections
+Entitled "Endorsements".
+
+
+6. COLLECTIONS OF DOCUMENTS
+
+You may make a collection consisting of the Document and other documents
+released under this License, and replace the individual copies of this
+License in the various documents with a single copy that is included in
+the collection, provided that you follow the rules of this License for
+verbatim copying of each of the documents in all other respects.
+
+You may extract a single document from such a collection, and distribute
+it individually under this License, provided you insert a copy of this
+License into the extracted document, and follow this License in all
+other respects regarding verbatim copying of that document.
+
+
+7. AGGREGATION WITH INDEPENDENT WORKS
+
+A compilation of the Document or its derivatives with other separate
+and independent documents or works, in or on a volume of a storage or
+distribution medium, is called an "aggregate" if the copyright
+resulting from the compilation is not used to limit the legal rights
+of the compilation's users beyond what the individual works permit.
+When the Document is included in an aggregate, this License does not
+apply to the other works in the aggregate which are not themselves
+derivative works of the Document.
+
+If the Cover Text requirement of section 3 is applicable to these
+copies of the Document, then if the Document is less than one half of
+the entire aggregate, the Document's Cover Texts may be placed on
+covers that bracket the Document within the aggregate, or the
+electronic equivalent of covers if the Document is in electronic form.
+Otherwise they must appear on printed covers that bracket the whole
+aggregate.
+
+
+8. TRANSLATION
+
+Translation is considered a kind of modification, so you may
+distribute translations of the Document under the terms of section 4.
+Replacing Invariant Sections with translations requires special
+permission from their copyright holders, but you may include
+translations of some or all Invariant Sections in addition to the
+original versions of these Invariant Sections. You may include a
+translation of this License, and all the license notices in the
+Document, and any Warranty Disclaimers, provided that you also include
+the original English version of this License and the original versions
+of those notices and disclaimers. In case of a disagreement between
+the translation and the original version of this License or a notice
+or disclaimer, the original version will prevail.
+
+If a section in the Document is Entitled "Acknowledgements",
+"Dedications", or "History", the requirement (section 4) to Preserve
+its Title (section 1) will typically require changing the actual
+title.
+
+
+9. TERMINATION
+
+You may not copy, modify, sublicense, or distribute the Document except
+as expressly provided for under this License. Any other attempt to
+copy, modify, sublicense or distribute the Document is void, and will
+automatically terminate your rights under this License. However,
+parties who have received copies, or rights, from you under this
+License will not have their licenses terminated so long as such
+parties remain in full compliance.
+
+
+10. FUTURE REVISIONS OF THIS LICENSE
+
+The Free Software Foundation may publish new, revised versions
+of the GNU Free Documentation License from time to time. Such new
+versions will be similar in spirit to the present version, but may
+differ in detail to address new problems or concerns. See
+https://www.gnu.org/licenses/.
+
+Each version of the License is given a distinguishing version number.
+If the Document specifies that a particular numbered version of this
+License "or any later version" applies to it, you have the option of
+following the terms and conditions either of that specified version or
+of any later version that has been published (not as a draft) by the
+Free Software Foundation. If the Document does not specify a version
+number of this License, you may choose any version ever published (not
+as a draft) by the Free Software Foundation.
+
+
+ADDENDUM: How to use this License for your documents
+
+To use this License in a document you have written, include a copy of
+the License in the document and put the following copyright and
+license notices just after the title page:
+
+ Copyright (c) YEAR YOUR NAME.
+ Permission is granted to copy, distribute and/or modify this document
+ under the terms of the GNU Free Documentation License, Version 1.2
+ or any later version published by the Free Software Foundation;
+ with no Invariant Sections, no Front-Cover Texts, and no Back-Cover Texts.
+ A copy of the license is included in the section entitled "GNU
+ Free Documentation License".
+
+If you have Invariant Sections, Front-Cover Texts and Back-Cover Texts,
+replace the "with...Texts." line with this:
+
+ with the Invariant Sections being LIST THEIR TITLES, with the
+ Front-Cover Texts being LIST, and with the Back-Cover Texts being LIST.
+
+If you have Invariant Sections without Cover Texts, or some other
+combination of the three, merge those two alternatives to suit the
+situation.
+
+If your document contains nontrivial examples of program code, we
+recommend releasing these examples in parallel under your choice of
+free software license, such as the GNU General Public License,
+to permit their use in free software.
--
2.26.2
^ permalink raw reply related [flat|nested] 15+ messages in thread
* [PATCH v2 4/9] docs: trace: ring-buffer-design.txt: convert to ReST format
2020-06-23 9:52 [PATCH v2 0/9] Convert the remaining text files to ReST and add SPDX for GFDL Mauro Carvalho Chehab
2020-06-23 9:52 ` [PATCH v2 1/9] docs: dt: convert booting-without-of.txt to ReST format Mauro Carvalho Chehab
2020-06-23 9:52 ` [PATCH v2 2/9] LICENSES: add GFDL licenses Mauro Carvalho Chehab
@ 2020-06-23 9:52 ` Mauro Carvalho Chehab
2020-06-23 9:52 ` [PATCH v2 5/9] docs: move nommu-mmap.txt to admin-guide and rename to ReST Mauro Carvalho Chehab
` (5 subsequent siblings)
8 siblings, 0 replies; 15+ messages in thread
From: Mauro Carvalho Chehab @ 2020-06-23 9:52 UTC (permalink / raw)
To: Linux Doc Mailing List
Cc: Mauro Carvalho Chehab, linux-kernel, Jonathan Corbet
- Just like some media documents, this file is dual licensed
with GPL and GFDL. As right now the GFDL SPDX definition is
bogus (as it doesn't tell anything about invariant parts),
let's not use SPDX here. Let's use, instead, the same test
as we have on media.
- Convert title to ReST format;
- use :field: markup;
- Proper mark literal blocks as such;
- Add it to trace/index.rst file.
Signed-off-by: Mauro Carvalho Chehab <mchehab+huawei@kernel.org>
---
Documentation/trace/index.rst | 1 +
...ffer-design.txt => ring-buffer-design.rst} | 778 +++++++++---------
2 files changed, 404 insertions(+), 375 deletions(-)
rename Documentation/trace/{ring-buffer-design.txt => ring-buffer-design.rst} (57%)
diff --git a/Documentation/trace/index.rst b/Documentation/trace/index.rst
index fa9e1c730f6a..7d83156c9ac1 100644
--- a/Documentation/trace/index.rst
+++ b/Documentation/trace/index.rst
@@ -22,6 +22,7 @@ Linux Tracing Technologies
boottime-trace
hwlat_detector
intel_th
+ ring-buffer-design
stm
sys-t
coresight/index
diff --git a/Documentation/trace/ring-buffer-design.txt b/Documentation/trace/ring-buffer-design.rst
similarity index 57%
rename from Documentation/trace/ring-buffer-design.txt
rename to Documentation/trace/ring-buffer-design.rst
index 2d53c6f25b91..27dbe818720e 100644
--- a/Documentation/trace/ring-buffer-design.txt
+++ b/Documentation/trace/ring-buffer-design.rst
@@ -1,11 +1,15 @@
- Lockless Ring Buffer Design
- ===========================
+.. SPDX-License-Identifier: GPL-2.0 OR GFDL-1.2-only-no-invariants
+
+===========================
+Lockless Ring Buffer Design
+===========================
Copyright 2009 Red Hat Inc.
- Author: Steven Rostedt <srostedt@redhat.com>
- License: The GNU Free Documentation License, Version 1.2
- (dual licensed under the GPL v2)
-Reviewers: Mathieu Desnoyers, Huang Ying, Hidetoshi Seto,
+
+:Author: Steven Rostedt <srostedt@redhat.com>
+:License: The GNU Free Documentation License, Version 1.2
+ (dual licensed under the GPL v2)
+:Reviewers: Mathieu Desnoyers, Huang Ying, Hidetoshi Seto,
and Frederic Weisbecker.
@@ -14,37 +18,50 @@ Written for: 2.6.31
Terminology used in this Document
---------------------------------
-tail - where new writes happen in the ring buffer.
+tail
+ - where new writes happen in the ring buffer.
-head - where new reads happen in the ring buffer.
+head
+ - where new reads happen in the ring buffer.
-producer - the task that writes into the ring buffer (same as writer)
+producer
+ - the task that writes into the ring buffer (same as writer)
-writer - same as producer
+writer
+ - same as producer
-consumer - the task that reads from the buffer (same as reader)
+consumer
+ - the task that reads from the buffer (same as reader)
-reader - same as consumer.
+reader
+ - same as consumer.
-reader_page - A page outside the ring buffer used solely (for the most part)
- by the reader.
+reader_page
+ - A page outside the ring buffer used solely (for the most part)
+ by the reader.
-head_page - a pointer to the page that the reader will use next
+head_page
+ - a pointer to the page that the reader will use next
-tail_page - a pointer to the page that will be written to next
+tail_page
+ - a pointer to the page that will be written to next
-commit_page - a pointer to the page with the last finished non-nested write.
+commit_page
+ - a pointer to the page with the last finished non-nested write.
-cmpxchg - hardware-assisted atomic transaction that performs the following:
+cmpxchg
+ - hardware-assisted atomic transaction that performs the following::
- A = B if previous A == C
+ A = B if previous A == C
- R = cmpxchg(A, C, B) is saying that we replace A with B if and only if
- current A is equal to C, and we put the old (current) A into R
+ R = cmpxchg(A, C, B) is saying that we replace A with B if and only
+ if current A is equal to C, and we put the old (current)
+ A into R
- R gets the previous A regardless if A is updated with B or not.
+ R gets the previous A regardless if A is updated with B or not.
- To see if the update was successful a compare of R == C may be used.
+ To see if the update was successful a compare of ``R == C``
+ may be used.
The Generic Ring Buffer
-----------------------
@@ -64,7 +81,7 @@ No two writers can write at the same time (on the same per-cpu buffer),
but a writer may interrupt another writer, but it must finish writing
before the previous writer may continue. This is very important to the
algorithm. The writers act like a "stack". The way interrupts works
-enforces this behavior.
+enforces this behavior::
writer1 start
@@ -115,6 +132,8 @@ A sample of how the reader page is swapped: Note this does not
show the head page in the buffer, it is for demonstrating a swap
only.
+::
+
+------+
|reader| RING BUFFER
|page |
@@ -172,21 +191,22 @@ only.
It is possible that the page swapped is the commit page and the tail page,
if what is in the ring buffer is less than what is held in a buffer page.
+::
- reader page commit page tail page
- | | |
- v | |
- +---+ | |
- | |<----------+ |
- | |<------------------------+
- | |------+
- +---+ |
- |
- v
- +---+ +---+ +---+ +---+
-<---| |--->| |--->| |--->| |--->
---->| |<---| |<---| |<---| |<---
- +---+ +---+ +---+ +---+
+ reader page commit page tail page
+ | | |
+ v | |
+ +---+ | |
+ | |<----------+ |
+ | |<------------------------+
+ | |------+
+ +---+ |
+ |
+ v
+ +---+ +---+ +---+ +---+
+ <---| |--->| |--->| |--->| |--->
+ --->| |<---| |<---| |<---| |<---
+ +---+ +---+ +---+ +---+
This case is still valid for this algorithm.
When the writer leaves the page, it simply goes into the ring buffer
@@ -196,15 +216,19 @@ buffer.
The main pointers:
- reader page - The page used solely by the reader and is not part
- of the ring buffer (may be swapped in)
+ reader page
+ - The page used solely by the reader and is not part
+ of the ring buffer (may be swapped in)
- head page - the next page in the ring buffer that will be swapped
+ head page
+ - the next page in the ring buffer that will be swapped
with the reader page.
- tail page - the page where the next write will take place.
+ tail page
+ - the page where the next write will take place.
- commit page - the page that last finished a write.
+ commit page
+ - the page that last finished a write.
The commit page only is updated by the outermost writer in the
writer stack. A writer that preempts another writer will not move the
@@ -219,7 +243,7 @@ transaction. If another write happens it must finish before continuing
with the previous write.
- Write reserve:
+ Write reserve::
Buffer page
+---------+
@@ -230,7 +254,7 @@ with the previous write.
| empty |
+---------+
- Write commit:
+ Write commit::
Buffer page
+---------+
@@ -242,7 +266,7 @@ with the previous write.
+---------+
- If a write happens after the first reserve:
+ If a write happens after the first reserve::
Buffer page
+---------+
@@ -253,7 +277,7 @@ with the previous write.
|reserved |
+---------+ <--- tail pointer
- After second writer commits:
+ After second writer commits::
Buffer page
@@ -266,7 +290,7 @@ with the previous write.
|commit |
+---------+ <--- tail pointer
- When the first writer commits:
+ When the first writer commits::
Buffer page
+---------+
@@ -292,21 +316,22 @@ be several pages ahead. If the tail page catches up to the commit
page then no more writes may take place (regardless of the mode
of the ring buffer: overwrite and produce/consumer).
-The order of pages is:
+The order of pages is::
head page
commit page
tail page
-Possible scenario:
- tail page
- head page commit page |
- | | |
- v v v
- +---+ +---+ +---+ +---+
-<---| |--->| |--->| |--->| |--->
---->| |<---| |<---| |<---| |<---
- +---+ +---+ +---+ +---+
+Possible scenario::
+
+ tail page
+ head page commit page |
+ | | |
+ v v v
+ +---+ +---+ +---+ +---+
+ <---| |--->| |--->| |--->| |--->
+ --->| |<---| |<---| |<---| |<---
+ +---+ +---+ +---+ +---+
There is a special case that the head page is after either the commit page
and possibly the tail page. That is when the commit (and tail) page has been
@@ -315,24 +340,25 @@ part of the ring buffer, but the reader page is not. Whenever there
has been less than a full page that has been committed inside the ring buffer,
and a reader swaps out a page, it will be swapping out the commit page.
+::
- reader page commit page tail page
- | | |
- v | |
- +---+ | |
- | |<----------+ |
- | |<------------------------+
- | |------+
- +---+ |
- |
- v
- +---+ +---+ +---+ +---+
-<---| |--->| |--->| |--->| |--->
---->| |<---| |<---| |<---| |<---
- +---+ +---+ +---+ +---+
- ^
- |
- head page
+ reader page commit page tail page
+ | | |
+ v | |
+ +---+ | |
+ | |<----------+ |
+ | |<------------------------+
+ | |------+
+ +---+ |
+ |
+ v
+ +---+ +---+ +---+ +---+
+ <---| |--->| |--->| |--->| |--->
+ --->| |<---| |<---| |<---| |<---
+ +---+ +---+ +---+ +---+
+ ^
+ |
+ head page
In this case, the head page will not move when the tail and commit
@@ -347,42 +373,42 @@ When the tail meets the head page, if the buffer is in overwrite mode,
the head page will be pushed ahead one. If the buffer is in producer/consumer
mode, the write will fail.
-Overwrite mode:
+Overwrite mode::
- tail page
- |
- v
- +---+ +---+ +---+ +---+
-<---| |--->| |--->| |--->| |--->
---->| |<---| |<---| |<---| |<---
- +---+ +---+ +---+ +---+
- ^
- |
- head page
+ tail page
+ |
+ v
+ +---+ +---+ +---+ +---+
+ <---| |--->| |--->| |--->| |--->
+ --->| |<---| |<---| |<---| |<---
+ +---+ +---+ +---+ +---+
+ ^
+ |
+ head page
- tail page
- |
- v
- +---+ +---+ +---+ +---+
-<---| |--->| |--->| |--->| |--->
---->| |<---| |<---| |<---| |<---
- +---+ +---+ +---+ +---+
- ^
- |
- head page
+ tail page
+ |
+ v
+ +---+ +---+ +---+ +---+
+ <---| |--->| |--->| |--->| |--->
+ --->| |<---| |<---| |<---| |<---
+ +---+ +---+ +---+ +---+
+ ^
+ |
+ head page
- tail page
- |
- v
- +---+ +---+ +---+ +---+
-<---| |--->| |--->| |--->| |--->
---->| |<---| |<---| |<---| |<---
- +---+ +---+ +---+ +---+
- ^
- |
- head page
+ tail page
+ |
+ v
+ +---+ +---+ +---+ +---+
+ <---| |--->| |--->| |--->| |--->
+ --->| |<---| |<---| |<---| |<---
+ +---+ +---+ +---+ +---+
+ ^
+ |
+ head page
Note, the reader page will still point to the previous head page.
But when a swap takes place, it will use the most recent head page.
@@ -397,7 +423,7 @@ State flags are placed inside the pointer to the page. To do this,
each page must be aligned in memory by 4 bytes. This will allow the 2
least significant bits of the address to be used as flags, since
they will always be zero for the address. To get the address,
-simply mask out the flags.
+simply mask out the flags::
MASK = ~3
@@ -405,24 +431,27 @@ simply mask out the flags.
Two flags will be kept by these two bits:
- HEADER - the page being pointed to is a head page
+ HEADER
+ - the page being pointed to is a head page
- UPDATE - the page being pointed to is being updated by a writer
+ UPDATE
+ - the page being pointed to is being updated by a writer
and was or is about to be a head page.
+::
- reader page
- |
- v
- +---+
- | |------+
- +---+ |
- |
- v
- +---+ +---+ +---+ +---+
-<---| |--->| |-H->| |--->| |--->
---->| |<---| |<---| |<---| |<---
- +---+ +---+ +---+ +---+
+ reader page
+ |
+ v
+ +---+
+ | |------+
+ +---+ |
+ |
+ v
+ +---+ +---+ +---+ +---+
+ <---| |--->| |-H->| |--->| |--->
+ --->| |<---| |<---| |<---| |<---
+ +---+ +---+ +---+ +---+
The above pointer "-H->" would have the HEADER flag set. That is
@@ -430,24 +459,24 @@ the next page is the next page to be swapped out by the reader.
This pointer means the next page is the head page.
When the tail page meets the head pointer, it will use cmpxchg to
-change the pointer to the UPDATE state:
+change the pointer to the UPDATE state::
- tail page
- |
- v
- +---+ +---+ +---+ +---+
-<---| |--->| |-H->| |--->| |--->
---->| |<---| |<---| |<---| |<---
- +---+ +---+ +---+ +---+
+ tail page
+ |
+ v
+ +---+ +---+ +---+ +---+
+ <---| |--->| |-H->| |--->| |--->
+ --->| |<---| |<---| |<---| |<---
+ +---+ +---+ +---+ +---+
- tail page
- |
- v
- +---+ +---+ +---+ +---+
-<---| |--->| |-U->| |--->| |--->
---->| |<---| |<---| |<---| |<---
- +---+ +---+ +---+ +---+
+ tail page
+ |
+ v
+ +---+ +---+ +---+ +---+
+ <---| |--->| |-U->| |--->| |--->
+ --->| |<---| |<---| |<---| |<---
+ +---+ +---+ +---+ +---+
"-U->" represents a pointer in the UPDATE state.
@@ -462,7 +491,7 @@ head page does not have the HEADER flag set, the compare will fail
and the reader will need to look for the new head page and try again.
Note, the flags UPDATE and HEADER are never set at the same time.
-The reader swaps the reader page as follows:
+The reader swaps the reader page as follows::
+------+
|reader| RING BUFFER
@@ -477,7 +506,7 @@ The reader swaps the reader page as follows:
+-----H-------------+
The reader sets the reader page next pointer as HEADER to the page after
-the head page.
+the head page::
+------+
@@ -495,7 +524,7 @@ the head page.
It does a cmpxchg with the pointer to the previous head page to make it
point to the reader page. Note that the new pointer does not have the HEADER
-flag set. This action atomically moves the head page forward.
+flag set. This action atomically moves the head page forward::
+------+
|reader| RING BUFFER
@@ -511,7 +540,7 @@ flag set. This action atomically moves the head page forward.
+------------------------------------+
After the new head page is set, the previous pointer of the head page is
-updated to the reader page.
+updated to the reader page::
+------+
|reader| RING BUFFER
@@ -548,7 +577,7 @@ prev pointers may not.
Note, the way to determine a reader page is simply by examining the previous
pointer of the page. If the next pointer of the previous page does not
-point back to the original page, then the original page is a reader page:
+point back to the original page, then the original page is a reader page::
+--------+
@@ -572,54 +601,54 @@ not be able to swap the head page from the buffer, nor will it be able to
move the head page, until the writer is finished with the move.
This eliminates any races that the reader can have on the writer. The reader
-must spin, and this is why the reader cannot preempt the writer.
+must spin, and this is why the reader cannot preempt the writer::
- tail page
- |
- v
- +---+ +---+ +---+ +---+
-<---| |--->| |-H->| |--->| |--->
---->| |<---| |<---| |<---| |<---
- +---+ +---+ +---+ +---+
+ tail page
+ |
+ v
+ +---+ +---+ +---+ +---+
+ <---| |--->| |-H->| |--->| |--->
+ --->| |<---| |<---| |<---| |<---
+ +---+ +---+ +---+ +---+
- tail page
- |
- v
- +---+ +---+ +---+ +---+
-<---| |--->| |-U->| |--->| |--->
---->| |<---| |<---| |<---| |<---
- +---+ +---+ +---+ +---+
+ tail page
+ |
+ v
+ +---+ +---+ +---+ +---+
+ <---| |--->| |-U->| |--->| |--->
+ --->| |<---| |<---| |<---| |<---
+ +---+ +---+ +---+ +---+
-The following page will be made into the new head page.
+The following page will be made into the new head page::
- tail page
- |
- v
- +---+ +---+ +---+ +---+
-<---| |--->| |-U->| |-H->| |--->
---->| |<---| |<---| |<---| |<---
- +---+ +---+ +---+ +---+
+ tail page
+ |
+ v
+ +---+ +---+ +---+ +---+
+ <---| |--->| |-U->| |-H->| |--->
+ --->| |<---| |<---| |<---| |<---
+ +---+ +---+ +---+ +---+
After the new head page has been set, we can set the old head page
-pointer back to NORMAL.
+pointer back to NORMAL::
- tail page
- |
- v
- +---+ +---+ +---+ +---+
-<---| |--->| |--->| |-H->| |--->
---->| |<---| |<---| |<---| |<---
- +---+ +---+ +---+ +---+
+ tail page
+ |
+ v
+ +---+ +---+ +---+ +---+
+ <---| |--->| |--->| |-H->| |--->
+ --->| |<---| |<---| |<---| |<---
+ +---+ +---+ +---+ +---+
-After the head page has been moved, the tail page may now move forward.
+After the head page has been moved, the tail page may now move forward::
- tail page
- |
- v
- +---+ +---+ +---+ +---+
-<---| |--->| |--->| |-H->| |--->
---->| |<---| |<---| |<---| |<---
- +---+ +---+ +---+ +---+
+ tail page
+ |
+ v
+ +---+ +---+ +---+ +---+
+ <---| |--->| |--->| |-H->| |--->
+ --->| |<---| |<---| |<---| |<---
+ +---+ +---+ +---+ +---+
The above are the trivial updates. Now for the more complex scenarios.
@@ -630,26 +659,26 @@ tail page may make it all the way around the buffer and meet the commit
page. At this time, we must start dropping writes (usually with some kind
of warning to the user). But what happens if the commit was still on the
reader page? The commit page is not part of the ring buffer. The tail page
-must account for this.
+must account for this::
- reader page commit page
- | |
- v |
- +---+ |
- | |<----------+
- | |
- | |------+
- +---+ |
- |
- v
- +---+ +---+ +---+ +---+
-<---| |--->| |-H->| |--->| |--->
---->| |<---| |<---| |<---| |<---
- +---+ +---+ +---+ +---+
- ^
- |
- tail page
+ reader page commit page
+ | |
+ v |
+ +---+ |
+ | |<----------+
+ | |
+ | |------+
+ +---+ |
+ |
+ v
+ +---+ +---+ +---+ +---+
+ <---| |--->| |-H->| |--->| |--->
+ --->| |<---| |<---| |<---| |<---
+ +---+ +---+ +---+ +---+
+ ^
+ |
+ tail page
If the tail page were to simply push the head page forward, the commit when
leaving the reader page would not be pointing to the correct page.
@@ -676,7 +705,7 @@ the head page if the head page is the next page. If the head page
is not the next page, the tail page is simply updated with a cmpxchg.
Only writers move the tail page. This must be done atomically to protect
-against nested writers.
+against nested writers::
temp_page = tail_page
next_page = temp_page->next
@@ -684,54 +713,54 @@ against nested writers.
The above will update the tail page if it is still pointing to the expected
page. If this fails, a nested write pushed it forward, the current write
-does not need to push it.
+does not need to push it::
- temp page
- |
- v
- tail page
- |
- v
- +---+ +---+ +---+ +---+
-<---| |--->| |--->| |--->| |--->
---->| |<---| |<---| |<---| |<---
- +---+ +---+ +---+ +---+
+ temp page
+ |
+ v
+ tail page
+ |
+ v
+ +---+ +---+ +---+ +---+
+ <---| |--->| |--->| |--->| |--->
+ --->| |<---| |<---| |<---| |<---
+ +---+ +---+ +---+ +---+
-Nested write comes in and moves the tail page forward:
+Nested write comes in and moves the tail page forward::
- tail page (moved by nested writer)
- temp page |
- | |
- v v
- +---+ +---+ +---+ +---+
-<---| |--->| |--->| |--->| |--->
---->| |<---| |<---| |<---| |<---
- +---+ +---+ +---+ +---+
+ tail page (moved by nested writer)
+ temp page |
+ | |
+ v v
+ +---+ +---+ +---+ +---+
+ <---| |--->| |--->| |--->| |--->
+ --->| |<---| |<---| |<---| |<---
+ +---+ +---+ +---+ +---+
The above would fail the cmpxchg, but since the tail page has already
been moved forward, the writer will just try again to reserve storage
on the new tail page.
-But the moving of the head page is a bit more complex.
+But the moving of the head page is a bit more complex::
- tail page
- |
- v
- +---+ +---+ +---+ +---+
-<---| |--->| |-H->| |--->| |--->
---->| |<---| |<---| |<---| |<---
- +---+ +---+ +---+ +---+
+ tail page
+ |
+ v
+ +---+ +---+ +---+ +---+
+ <---| |--->| |-H->| |--->| |--->
+ --->| |<---| |<---| |<---| |<---
+ +---+ +---+ +---+ +---+
-The write converts the head page pointer to UPDATE.
+The write converts the head page pointer to UPDATE::
- tail page
- |
- v
- +---+ +---+ +---+ +---+
-<---| |--->| |-U->| |--->| |--->
---->| |<---| |<---| |<---| |<---
- +---+ +---+ +---+ +---+
+ tail page
+ |
+ v
+ +---+ +---+ +---+ +---+
+ <---| |--->| |-U->| |--->| |--->
+ --->| |<---| |<---| |<---| |<---
+ +---+ +---+ +---+ +---+
But if a nested writer preempts here, it will see that the next
page is a head page, but it is also nested. It will detect that
@@ -739,217 +768,216 @@ it is nested and will save that information. The detection is the
fact that it sees the UPDATE flag instead of a HEADER or NORMAL
pointer.
-The nested writer will set the new head page pointer.
+The nested writer will set the new head page pointer::
- tail page
- |
- v
- +---+ +---+ +---+ +---+
-<---| |--->| |-U->| |-H->| |--->
---->| |<---| |<---| |<---| |<---
- +---+ +---+ +---+ +---+
+ tail page
+ |
+ v
+ +---+ +---+ +---+ +---+
+ <---| |--->| |-U->| |-H->| |--->
+ --->| |<---| |<---| |<---| |<---
+ +---+ +---+ +---+ +---+
But it will not reset the update back to normal. Only the writer
that converted a pointer from HEAD to UPDATE will convert it back
-to NORMAL.
+to NORMAL::
- tail page
- |
- v
- +---+ +---+ +---+ +---+
-<---| |--->| |-U->| |-H->| |--->
---->| |<---| |<---| |<---| |<---
- +---+ +---+ +---+ +---+
+ tail page
+ |
+ v
+ +---+ +---+ +---+ +---+
+ <---| |--->| |-U->| |-H->| |--->
+ --->| |<---| |<---| |<---| |<---
+ +---+ +---+ +---+ +---+
After the nested writer finishes, the outermost writer will convert
-the UPDATE pointer to NORMAL.
+the UPDATE pointer to NORMAL::
- tail page
- |
- v
- +---+ +---+ +---+ +---+
-<---| |--->| |--->| |-H->| |--->
---->| |<---| |<---| |<---| |<---
- +---+ +---+ +---+ +---+
+ tail page
+ |
+ v
+ +---+ +---+ +---+ +---+
+ <---| |--->| |--->| |-H->| |--->
+ --->| |<---| |<---| |<---| |<---
+ +---+ +---+ +---+ +---+
It can be even more complex if several nested writes came in and moved
-the tail page ahead several pages:
+the tail page ahead several pages::
-(first writer)
+ (first writer)
- tail page
- |
- v
- +---+ +---+ +---+ +---+
-<---| |--->| |-H->| |--->| |--->
---->| |<---| |<---| |<---| |<---
- +---+ +---+ +---+ +---+
+ tail page
+ |
+ v
+ +---+ +---+ +---+ +---+
+ <---| |--->| |-H->| |--->| |--->
+ --->| |<---| |<---| |<---| |<---
+ +---+ +---+ +---+ +---+
-The write converts the head page pointer to UPDATE.
+The write converts the head page pointer to UPDATE::
- tail page
- |
- v
- +---+ +---+ +---+ +---+
-<---| |--->| |-U->| |--->| |--->
---->| |<---| |<---| |<---| |<---
- +---+ +---+ +---+ +---+
+ tail page
+ |
+ v
+ +---+ +---+ +---+ +---+
+ <---| |--->| |-U->| |--->| |--->
+ --->| |<---| |<---| |<---| |<---
+ +---+ +---+ +---+ +---+
Next writer comes in, and sees the update and sets up the new
-head page.
+head page::
-(second writer)
+ (second writer)
- tail page
- |
- v
- +---+ +---+ +---+ +---+
-<---| |--->| |-U->| |-H->| |--->
---->| |<---| |<---| |<---| |<---
- +---+ +---+ +---+ +---+
+ tail page
+ |
+ v
+ +---+ +---+ +---+ +---+
+ <---| |--->| |-U->| |-H->| |--->
+ --->| |<---| |<---| |<---| |<---
+ +---+ +---+ +---+ +---+
The nested writer moves the tail page forward. But does not set the old
-update page to NORMAL because it is not the outermost writer.
+update page to NORMAL because it is not the outermost writer::
- tail page
- |
- v
- +---+ +---+ +---+ +---+
-<---| |--->| |-U->| |-H->| |--->
---->| |<---| |<---| |<---| |<---
- +---+ +---+ +---+ +---+
+ tail page
+ |
+ v
+ +---+ +---+ +---+ +---+
+ <---| |--->| |-U->| |-H->| |--->
+ --->| |<---| |<---| |<---| |<---
+ +---+ +---+ +---+ +---+
Another writer preempts and sees the page after the tail page is a head page.
-It changes it from HEAD to UPDATE.
+It changes it from HEAD to UPDATE::
-(third writer)
+ (third writer)
- tail page
- |
- v
- +---+ +---+ +---+ +---+
-<---| |--->| |-U->| |-U->| |--->
---->| |<---| |<---| |<---| |<---
- +---+ +---+ +---+ +---+
+ tail page
+ |
+ v
+ +---+ +---+ +---+ +---+
+ <---| |--->| |-U->| |-U->| |--->
+ --->| |<---| |<---| |<---| |<---
+ +---+ +---+ +---+ +---+
-The writer will move the head page forward:
+The writer will move the head page forward::
-(third writer)
+ (third writer)
- tail page
- |
- v
- +---+ +---+ +---+ +---+
-<---| |--->| |-U->| |-U->| |-H->
---->| |<---| |<---| |<---| |<---
- +---+ +---+ +---+ +---+
+ tail page
+ |
+ v
+ +---+ +---+ +---+ +---+
+ <---| |--->| |-U->| |-U->| |-H->
+ --->| |<---| |<---| |<---| |<---
+ +---+ +---+ +---+ +---+
But now that the third writer did change the HEAD flag to UPDATE it
-will convert it to normal:
+will convert it to normal::
-(third writer)
+ (third writer)
- tail page
- |
- v
- +---+ +---+ +---+ +---+
-<---| |--->| |-U->| |--->| |-H->
---->| |<---| |<---| |<---| |<---
- +---+ +---+ +---+ +---+
+ tail page
+ |
+ v
+ +---+ +---+ +---+ +---+
+ <---| |--->| |-U->| |--->| |-H->
+ --->| |<---| |<---| |<---| |<---
+ +---+ +---+ +---+ +---+
-Then it will move the tail page, and return back to the second writer.
+Then it will move the tail page, and return back to the second writer::
-(second writer)
+ (second writer)
- tail page
- |
- v
- +---+ +---+ +---+ +---+
-<---| |--->| |-U->| |--->| |-H->
---->| |<---| |<---| |<---| |<---
- +---+ +---+ +---+ +---+
+ tail page
+ |
+ v
+ +---+ +---+ +---+ +---+
+ <---| |--->| |-U->| |--->| |-H->
+ --->| |<---| |<---| |<---| |<---
+ +---+ +---+ +---+ +---+
The second writer will fail to move the tail page because it was already
moved, so it will try again and add its data to the new tail page.
-It will return to the first writer.
+It will return to the first writer::
-(first writer)
+ (first writer)
- tail page
- |
- v
- +---+ +---+ +---+ +---+
-<---| |--->| |-U->| |--->| |-H->
---->| |<---| |<---| |<---| |<---
- +---+ +---+ +---+ +---+
+ tail page
+ |
+ v
+ +---+ +---+ +---+ +---+
+ <---| |--->| |-U->| |--->| |-H->
+ --->| |<---| |<---| |<---| |<---
+ +---+ +---+ +---+ +---+
The first writer cannot know atomically if the tail page moved
while it updates the HEAD page. It will then update the head page to
-what it thinks is the new head page.
+what it thinks is the new head page::
-(first writer)
+ (first writer)
- tail page
- |
- v
- +---+ +---+ +---+ +---+
-<---| |--->| |-U->| |-H->| |-H->
---->| |<---| |<---| |<---| |<---
- +---+ +---+ +---+ +---+
+ tail page
+ |
+ v
+ +---+ +---+ +---+ +---+
+ <---| |--->| |-U->| |-H->| |-H->
+ --->| |<---| |<---| |<---| |<---
+ +---+ +---+ +---+ +---+
Since the cmpxchg returns the old value of the pointer the first writer
will see it succeeded in updating the pointer from NORMAL to HEAD.
But as we can see, this is not good enough. It must also check to see
-if the tail page is either where it use to be or on the next page:
+if the tail page is either where it use to be or on the next page::
-(first writer)
+ (first writer)
- A B tail page
- | | |
- v v v
- +---+ +---+ +---+ +---+
-<---| |--->| |-U->| |-H->| |-H->
---->| |<---| |<---| |<---| |<---
- +---+ +---+ +---+ +---+
+ A B tail page
+ | | |
+ v v v
+ +---+ +---+ +---+ +---+
+ <---| |--->| |-U->| |-H->| |-H->
+ --->| |<---| |<---| |<---| |<---
+ +---+ +---+ +---+ +---+
If tail page != A and tail page != B, then it must reset the pointer
back to NORMAL. The fact that it only needs to worry about nested
-writers means that it only needs to check this after setting the HEAD page.
+writers means that it only needs to check this after setting the HEAD page::
-(first writer)
+ (first writer)
- A B tail page
- | | |
- v v v
- +---+ +---+ +---+ +---+
-<---| |--->| |-U->| |--->| |-H->
---->| |<---| |<---| |<---| |<---
- +---+ +---+ +---+ +---+
+ A B tail page
+ | | |
+ v v v
+ +---+ +---+ +---+ +---+
+ <---| |--->| |-U->| |--->| |-H->
+ --->| |<---| |<---| |<---| |<---
+ +---+ +---+ +---+ +---+
Now the writer can update the head page. This is also why the head page must
remain in UPDATE and only reset by the outermost writer. This prevents
-the reader from seeing the incorrect head page.
+the reader from seeing the incorrect head page::
-(first writer)
-
- A B tail page
- | | |
- v v v
- +---+ +---+ +---+ +---+
-<---| |--->| |--->| |--->| |-H->
---->| |<---| |<---| |<---| |<---
- +---+ +---+ +---+ +---+
+ (first writer)
+ A B tail page
+ | | |
+ v v v
+ +---+ +---+ +---+ +---+
+ <---| |--->| |--->| |--->| |-H->
+ --->| |<---| |<---| |<---| |<---
+ +---+ +---+ +---+ +---+
--
2.26.2
^ permalink raw reply related [flat|nested] 15+ messages in thread
* [PATCH v2 5/9] docs: move nommu-mmap.txt to admin-guide and rename to ReST
2020-06-23 9:52 [PATCH v2 0/9] Convert the remaining text files to ReST and add SPDX for GFDL Mauro Carvalho Chehab
` (2 preceding siblings ...)
2020-06-23 9:52 ` [PATCH v2 4/9] docs: trace: ring-buffer-design.txt: convert to ReST format Mauro Carvalho Chehab
@ 2020-06-23 9:52 ` Mauro Carvalho Chehab
2020-06-23 15:56 ` Mike Rapoport
2020-06-23 9:52 ` [PATCH v2 6/9] docs: move mailbox.txt to driver-api and rename it Mauro Carvalho Chehab
` (4 subsequent siblings)
8 siblings, 1 reply; 15+ messages in thread
From: Mauro Carvalho Chehab @ 2020-06-23 9:52 UTC (permalink / raw)
To: Linux Doc Mailing List
Cc: Mauro Carvalho Chehab, linux-kernel, Jonathan Corbet,
David Airlie, Daniel Vetter, Maarten Lankhorst, Maxime Ripard,
Thomas Zimmermann, Andrew Morton, dri-devel, linux-mm,
Mike Rapoport
The nommu-mmap.txt file provides description of user visible
behaviuour. So, move it to the admin-guide.
As it is already at the ReST, also rename it.
Suggested-by: Mike Rapoport <rppt@linux.ibm.com>
Suggested-by: Jonathan Corbet <corbet@lwn.net>
Signed-off-by: Mauro Carvalho Chehab <mchehab+huawei@kernel.org>
---
Documentation/admin-guide/mm/index.rst | 1 +
Documentation/{nommu-mmap.txt => admin-guide/mm/nommu-mmap.rst} | 0
Documentation/admin-guide/sysctl/vm.rst | 2 +-
Documentation/gpu/drm-mm.rst | 2 +-
init/Kconfig | 2 +-
mm/Kconfig | 2 +-
mm/nommu.c | 2 +-
7 files changed, 6 insertions(+), 5 deletions(-)
rename Documentation/{nommu-mmap.txt => admin-guide/mm/nommu-mmap.rst} (100%)
diff --git a/Documentation/admin-guide/mm/index.rst b/Documentation/admin-guide/mm/index.rst
index 11db46448354..774dad6d3d29 100644
--- a/Documentation/admin-guide/mm/index.rst
+++ b/Documentation/admin-guide/mm/index.rst
@@ -31,6 +31,7 @@ the Linux memory management.
idle_page_tracking
ksm
memory-hotplug
+ nommu-map
numa_memory_policy
numaperf
pagemap
diff --git a/Documentation/nommu-mmap.txt b/Documentation/admin-guide/mm/nommu-mmap.rst
similarity index 100%
rename from Documentation/nommu-mmap.txt
rename to Documentation/admin-guide/mm/nommu-mmap.rst
diff --git a/Documentation/admin-guide/sysctl/vm.rst b/Documentation/admin-guide/sysctl/vm.rst
index 4b7c496199ca..4b9d2e8e9142 100644
--- a/Documentation/admin-guide/sysctl/vm.rst
+++ b/Documentation/admin-guide/sysctl/vm.rst
@@ -598,7 +598,7 @@ trimming of allocations is initiated.
The default value is 1.
-See Documentation/nommu-mmap.txt for more information.
+See Documentation/admin-guide/mm/nommu-mmap.rst for more information.
numa_zonelist_order
diff --git a/Documentation/gpu/drm-mm.rst b/Documentation/gpu/drm-mm.rst
index 8d10e6b38918..9abee1589c1e 100644
--- a/Documentation/gpu/drm-mm.rst
+++ b/Documentation/gpu/drm-mm.rst
@@ -311,7 +311,7 @@ To use drm_gem_cma_get_unmapped_area(), drivers must fill the struct
a pointer on drm_gem_cma_get_unmapped_area().
More detailed information about get_unmapped_area can be found in
-Documentation/nommu-mmap.txt
+Documentation/admin-guide/mm/nommu-mmap.rst
Memory Coherency
----------------
diff --git a/init/Kconfig b/init/Kconfig
index a46aa8f3174d..2dd5531dae98 100644
--- a/init/Kconfig
+++ b/init/Kconfig
@@ -1957,7 +1957,7 @@ config MMAP_ALLOW_UNINITIALIZED
userspace. Since that isn't generally a problem on no-MMU systems,
it is normally safe to say Y here.
- See Documentation/nommu-mmap.txt for more information.
+ See Documentation/mm/nommu-mmap.rst for more information.
config SYSTEM_DATA_VERIFICATION
def_bool n
diff --git a/mm/Kconfig b/mm/Kconfig
index f2104cc0d35c..d41f3fa7e923 100644
--- a/mm/Kconfig
+++ b/mm/Kconfig
@@ -387,7 +387,7 @@ config NOMMU_INITIAL_TRIM_EXCESS
This option specifies the initial value of this option. The default
of 1 says that all excess pages should be trimmed.
- See Documentation/nommu-mmap.txt for more information.
+ See Documentation/mm/nommu-mmap.rst for more information.
config TRANSPARENT_HUGEPAGE
bool "Transparent Hugepage Support"
diff --git a/mm/nommu.c b/mm/nommu.c
index f32a69095d50..314174817b04 100644
--- a/mm/nommu.c
+++ b/mm/nommu.c
@@ -5,7 +5,7 @@
* Replacement code for mm functions to support CPU's that don't
* have any form of memory management unit (thus no virtual memory).
*
- * See Documentation/nommu-mmap.txt
+ * See Documentation/mm/nommu-mmap.rst
*
* Copyright (c) 2004-2008 David Howells <dhowells@redhat.com>
* Copyright (c) 2000-2003 David McCullough <davidm@snapgear.com>
--
2.26.2
^ permalink raw reply related [flat|nested] 15+ messages in thread
* [PATCH v2 6/9] docs: move mailbox.txt to driver-api and rename it
2020-06-23 9:52 [PATCH v2 0/9] Convert the remaining text files to ReST and add SPDX for GFDL Mauro Carvalho Chehab
` (3 preceding siblings ...)
2020-06-23 9:52 ` [PATCH v2 5/9] docs: move nommu-mmap.txt to admin-guide and rename to ReST Mauro Carvalho Chehab
@ 2020-06-23 9:52 ` Mauro Carvalho Chehab
2020-06-23 9:53 ` [PATCH v2 7/9] docs: move other kAPI documents to core-api Mauro Carvalho Chehab
` (3 subsequent siblings)
8 siblings, 0 replies; 15+ messages in thread
From: Mauro Carvalho Chehab @ 2020-06-23 9:52 UTC (permalink / raw)
To: Linux Doc Mailing List
Cc: Mauro Carvalho Chehab, linux-kernel, Jonathan Corbet
This file is already at the ReST format. Move it to
driver-api and rename it.
Suggested-by: Jonathan Corbet <corbet@lwn.net>
Signed-off-by: Mauro Carvalho Chehab <mchehab+huawei@kernel.org>
---
Documentation/driver-api/index.rst | 1 +
Documentation/{mailbox.txt => driver-api/mailbox.rst} | 0
2 files changed, 1 insertion(+)
rename Documentation/{mailbox.txt => driver-api/mailbox.rst} (100%)
diff --git a/Documentation/driver-api/index.rst b/Documentation/driver-api/index.rst
index 6567187e7687..3eb0085d5e42 100644
--- a/Documentation/driver-api/index.rst
+++ b/Documentation/driver-api/index.rst
@@ -48,6 +48,7 @@ available subsections can be seen below.
scsi
libata
target
+ mailbox
mtdnand
miscellaneous
mei/index
diff --git a/Documentation/mailbox.txt b/Documentation/driver-api/mailbox.rst
similarity index 100%
rename from Documentation/mailbox.txt
rename to Documentation/driver-api/mailbox.rst
--
2.26.2
^ permalink raw reply related [flat|nested] 15+ messages in thread
* [PATCH v2 7/9] docs: move other kAPI documents to core-api
2020-06-23 9:52 [PATCH v2 0/9] Convert the remaining text files to ReST and add SPDX for GFDL Mauro Carvalho Chehab
` (4 preceding siblings ...)
2020-06-23 9:52 ` [PATCH v2 6/9] docs: move mailbox.txt to driver-api and rename it Mauro Carvalho Chehab
@ 2020-06-23 9:53 ` Mauro Carvalho Chehab
2020-06-23 9:53 ` [PATCH v2 8/9] docs: Add remaining Documentation/*.txt at staging/index.rst Mauro Carvalho Chehab
` (2 subsequent siblings)
8 siblings, 0 replies; 15+ messages in thread
From: Mauro Carvalho Chehab @ 2020-06-23 9:53 UTC (permalink / raw)
To: Linux Doc Mailing List
Cc: Mauro Carvalho Chehab, linux-kernel, Jonathan Corbet
There are a number of random documents that seem to be
describing some aspects of the core-api. Move them to such
directory, adding them at the core-api/index.rst file.
Signed-off-by: Mauro Carvalho Chehab <mchehab+huawei@kernel.org>
---
.../bus-virt-phys-mapping.rst} | 0
Documentation/core-api/index.rst | 3 +++
Documentation/{this_cpu_ops.txt => core-api/this_cpu_ops.rst} | 0
.../{process => core-api}/unaligned-memory-access.rst | 0
arch/Kconfig | 2 +-
5 files changed, 4 insertions(+), 1 deletion(-)
rename Documentation/{bus-virt-phys-mapping.txt => core-api/bus-virt-phys-mapping.rst} (100%)
rename Documentation/{this_cpu_ops.txt => core-api/this_cpu_ops.rst} (100%)
rename Documentation/{process => core-api}/unaligned-memory-access.rst (100%)
diff --git a/Documentation/bus-virt-phys-mapping.txt b/Documentation/core-api/bus-virt-phys-mapping.rst
similarity index 100%
rename from Documentation/bus-virt-phys-mapping.txt
rename to Documentation/core-api/bus-virt-phys-mapping.rst
diff --git a/Documentation/core-api/index.rst b/Documentation/core-api/index.rst
index 15ab86112627..69171b1799f2 100644
--- a/Documentation/core-api/index.rst
+++ b/Documentation/core-api/index.rst
@@ -39,6 +39,8 @@ Library functionality that is used throughout the kernel.
rbtree
generic-radix-tree
packing
+ bus-virt-phys-mapping
+ this_cpu_ops
timekeeping
errseq
@@ -82,6 +84,7 @@ more memory-management documentation in :doc:`/vm/index`.
:maxdepth: 1
memory-allocation
+ unaligned-memory-access
dma-api
dma-api-howto
dma-attributes
diff --git a/Documentation/this_cpu_ops.txt b/Documentation/core-api/this_cpu_ops.rst
similarity index 100%
rename from Documentation/this_cpu_ops.txt
rename to Documentation/core-api/this_cpu_ops.rst
diff --git a/Documentation/process/unaligned-memory-access.rst b/Documentation/core-api/unaligned-memory-access.rst
similarity index 100%
rename from Documentation/process/unaligned-memory-access.rst
rename to Documentation/core-api/unaligned-memory-access.rst
diff --git a/arch/Kconfig b/arch/Kconfig
index 8cc35dc556c7..2a439fb8069e 100644
--- a/arch/Kconfig
+++ b/arch/Kconfig
@@ -147,7 +147,7 @@ config HAVE_EFFICIENT_UNALIGNED_ACCESS
problems with received packets if doing so would not help
much.
- See Documentation/unaligned-memory-access.txt for more
+ See Documentation/core-api/unaligned-memory-access.rst for more
information on the topic of unaligned memory accesses.
config ARCH_USE_BUILTIN_BSWAP
--
2.26.2
^ permalink raw reply related [flat|nested] 15+ messages in thread
* [PATCH v2 8/9] docs: Add remaining Documentation/*.txt at staging/index.rst
2020-06-23 9:52 [PATCH v2 0/9] Convert the remaining text files to ReST and add SPDX for GFDL Mauro Carvalho Chehab
` (5 preceding siblings ...)
2020-06-23 9:53 ` [PATCH v2 7/9] docs: move other kAPI documents to core-api Mauro Carvalho Chehab
@ 2020-06-23 9:53 ` Mauro Carvalho Chehab
2020-06-23 9:53 ` [PATCH v2 9/9] docs: staging: use small font for literal includes Mauro Carvalho Chehab
2020-06-23 11:58 ` [PATCH v2 0/9] Convert the remaining text files to ReST and add SPDX for GFDL Kate Stewart
8 siblings, 0 replies; 15+ messages in thread
From: Mauro Carvalho Chehab @ 2020-06-23 9:53 UTC (permalink / raw)
To: Linux Doc Mailing List
Cc: Mauro Carvalho Chehab, linux-kernel, Jonathan Corbet
There are a few text files that aren't yet at the docs building
system.
Add those to the staging/index.rst.
Signed-off-by: Mauro Carvalho Chehab <mchehab+huawei@kernel.org>
---
Documentation/staging/index.rst | 9 +++------
1 file changed, 3 insertions(+), 6 deletions(-)
diff --git a/Documentation/staging/index.rst b/Documentation/staging/index.rst
index 8cc9d94b0a13..8e98517675ca 100644
--- a/Documentation/staging/index.rst
+++ b/Documentation/staging/index.rst
@@ -19,17 +19,14 @@ Unsorted Documentation
Atomic Types
============
-.. include:: ../atomic_t.txt
- :literal:
+.. literalinclude:: ../atomic_t.txt
Atomic bitops
=============
-.. include:: ../atomic_bitops.txt
- :literal:
+.. literalinclude:: ../atomic_bitops.txt
Memory Barriers
===============
-.. include:: ../memory-barriers.txt
- :literal:
+.. literalinclude:: ../memory-barriers.txt
--
2.26.2
^ permalink raw reply related [flat|nested] 15+ messages in thread
* [PATCH v2 9/9] docs: staging: use small font for literal includes
2020-06-23 9:52 [PATCH v2 0/9] Convert the remaining text files to ReST and add SPDX for GFDL Mauro Carvalho Chehab
` (6 preceding siblings ...)
2020-06-23 9:53 ` [PATCH v2 8/9] docs: Add remaining Documentation/*.txt at staging/index.rst Mauro Carvalho Chehab
@ 2020-06-23 9:53 ` Mauro Carvalho Chehab
2020-06-23 23:12 ` Joe Perches
2020-06-23 11:58 ` [PATCH v2 0/9] Convert the remaining text files to ReST and add SPDX for GFDL Kate Stewart
8 siblings, 1 reply; 15+ messages in thread
From: Mauro Carvalho Chehab @ 2020-06-23 9:53 UTC (permalink / raw)
To: Linux Doc Mailing List
Cc: Mauro Carvalho Chehab, linux-kernel, Jonathan Corbet
The normal font is too big to display 80 columns, causing extra
breaks to be added at weird places.
change to the footnotesize, as this would fit a little bit
better.
Signed-off-by: Mauro Carvalho Chehab <mchehab+huawei@kernel.org>
---
Documentation/staging/index.rst | 33 ++++++++++++++++++++++++++++++---
1 file changed, 30 insertions(+), 3 deletions(-)
diff --git a/Documentation/staging/index.rst b/Documentation/staging/index.rst
index 8e98517675ca..184e6aece0a7 100644
--- a/Documentation/staging/index.rst
+++ b/Documentation/staging/index.rst
@@ -19,14 +19,41 @@ Unsorted Documentation
Atomic Types
============
-.. literalinclude:: ../atomic_t.txt
+.. raw:: latex
+
+ \footnotesize
+
+.. include:: ../atomic_t.txt
+ :literal:
+
+.. raw:: latex
+
+ \normalsize
Atomic bitops
=============
-.. literalinclude:: ../atomic_bitops.txt
+.. raw:: latex
+
+ \footnotesize
+
+.. include:: ../atomic_bitops.txt
+ :literal:
+
+.. raw:: latex
+
+ \normalsize
Memory Barriers
===============
-.. literalinclude:: ../memory-barriers.txt
+.. raw:: latex
+
+ \footnotesize
+
+.. include:: ../memory-barriers.txt
+ :literal:
+
+.. raw:: latex
+
+ \normalsize
--
2.26.2
^ permalink raw reply related [flat|nested] 15+ messages in thread
* Re: [PATCH v2 2/9] LICENSES: add GFDL licenses
2020-06-23 9:52 ` [PATCH v2 2/9] LICENSES: add GFDL licenses Mauro Carvalho Chehab
@ 2020-06-23 11:47 ` Kate Stewart
0 siblings, 0 replies; 15+ messages in thread
From: Kate Stewart @ 2020-06-23 11:47 UTC (permalink / raw)
To: Mauro Carvalho Chehab
Cc: Linux Doc Mailing List, LKML, Jonathan Corbet, Thomas Gleixner,
Greg Kroah-Hartman, linux-spdx
Hi Mauro,
On Tue, Jun 23, 2020 at 4:53 AM Mauro Carvalho Chehab
<mchehab+huawei@kernel.org> wrote:
>
> Those are used on some documentation texts.
>
> Signed-off-by: Mauro Carvalho Chehab <mchehab+huawei@kernel.org>
> ---
> LICENSES/deprecated/GFDL-1.1+ | 366 ++++++++++++++++++++++++++++++
> LICENSES/deprecated/GFDL-1.2 | 408 ++++++++++++++++++++++++++++++++++
> 2 files changed, 774 insertions(+)
> create mode 100644 LICENSES/deprecated/GFDL-1.1+
> create mode 100644 LICENSES/deprecated/GFDL-1.2
>
> diff --git a/LICENSES/deprecated/GFDL-1.1+ b/LICENSES/deprecated/GFDL-1.1+
> new file mode 100644
> index 000000000000..f65e4fcdc520
> --- /dev/null
> +++ b/LICENSES/deprecated/GFDL-1.1+
> @@ -0,0 +1,366 @@
> +Valid-License-Identifier: GFDL-1.1-or-later-no-invariants
> +SPDX-URL: https://github.com/spdx/license-list-XML/pull/1048/commits/f695d2ac65230d0f4161ba58fff2f9d87bb5a053#diff-b948674e5c5cf6341e44e76b2565e80c
> +Usage-Guide:
> + The GNU Free Documentation License with no Invariant Sections,
> + no Front-Cover Texts, and no Back-Cover Texts should not be used in new
> + code, except when dual-licensed with GPLv2.
> + To use the license in source code, put the following SPDX tag/value pair
> + into a comment according to the placement guidelines in the licensing
> + rules documentation:
> + SPDX-License-Identifier: GFDL-1.1-or-later-no-invariants
Adding a suffix of "-no-invarients" to "GFDL-1.1-or-later" is still under
discussion on the SPDX license list, and the syntax should probably
be GFDL-1.1-no-invariants-or later.
I've added a comment to the SPDX pull request to this effect,
so best to hold off on applying this until it gets through the
review process on the SPDX list.
> +License-Text:
> + GNU Free Documentation License
> + Version 1.1, March 2000
> +
> + Copyright (C) 2000 Free Software Foundation, Inc.
> + 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
> + Everyone is permitted to copy and distribute verbatim copies
> + of this license document, but changing it is not allowed.
> +
> +
> +0. PREAMBLE
> +
> +The purpose of this License is to make a manual, textbook, or other
> +written document "free" in the sense of freedom: to assure everyone
> +the effective freedom to copy and redistribute it, with or without
> +modifying it, either commercially or noncommercially. Secondarily,
> +this License preserves for the author and publisher a way to get
> +credit for their work, while not being considered responsible for
> +modifications made by others.
> +
> +This License is a kind of "copyleft", which means that derivative
> +works of the document must themselves be free in the same sense. It
> +complements the GNU General Public License, which is a copyleft
> +license designed for free software.
> +
> +We have designed this License in order to use it for manuals for free
> +software, because free software needs free documentation: a free
> +program should come with manuals providing the same freedoms that the
> +software does. But this License is not limited to software manuals;
> +it can be used for any textual work, regardless of subject matter or
> +whether it is published as a printed book. We recommend this License
> +principally for works whose purpose is instruction or reference.
> +
> +
> +1. APPLICABILITY AND DEFINITIONS
> +
> +This License applies to any manual or other work that contains a
> +notice placed by the copyright holder saying it can be distributed
> +under the terms of this License. The "Document", below, refers to any
> +such manual or work. Any member of the public is a licensee, and is
> +addressed as "you".
> +
> +A "Modified Version" of the Document means any work containing the
> +Document or a portion of it, either copied verbatim, or with
> +modifications and/or translated into another language.
> +
> +A "Secondary Section" is a named appendix or a front-matter section of
> +the Document that deals exclusively with the relationship of the
> +publishers or authors of the Document to the Document's overall subject
> +(or to related matters) and contains nothing that could fall directly
> +within that overall subject. (For example, if the Document is in part a
> +textbook of mathematics, a Secondary Section may not explain any
> +mathematics.) The relationship could be a matter of historical
> +connection with the subject or with related matters, or of legal,
> +commercial, philosophical, ethical or political position regarding
> +them.
> +
> +The "Invariant Sections" are certain Secondary Sections whose titles
> +are designated, as being those of Invariant Sections, in the notice
> +that says that the Document is released under this License.
> +
> +The "Cover Texts" are certain short passages of text that are listed,
> +as Front-Cover Texts or Back-Cover Texts, in the notice that says that
> +the Document is released under this License.
> +
> +A "Transparent" copy of the Document means a machine-readable copy,
> +represented in a format whose specification is available to the
> +general public, whose contents can be viewed and edited directly and
> +straightforwardly with generic text editors or (for images composed of
> +pixels) generic paint programs or (for drawings) some widely available
> +drawing editor, and that is suitable for input to text formatters or
> +for automatic translation to a variety of formats suitable for input
> +to text formatters. A copy made in an otherwise Transparent file
> +format whose markup has been designed to thwart or discourage
> +subsequent modification by readers is not Transparent. A copy that is
> +not "Transparent" is called "Opaque".
> +
> +Examples of suitable formats for Transparent copies include plain
> +ASCII without markup, Texinfo input format, LaTeX input format, SGML
> +or XML using a publicly available DTD, and standard-conforming simple
> +HTML designed for human modification. Opaque formats include
> +PostScript, PDF, proprietary formats that can be read and edited only
> +by proprietary word processors, SGML or XML for which the DTD and/or
> +processing tools are not generally available, and the
> +machine-generated HTML produced by some word processors for output
> +purposes only.
> +
> +The "Title Page" means, for a printed book, the title page itself,
> +plus such following pages as are needed to hold, legibly, the material
> +this License requires to appear in the title page. For works in
> +formats which do not have any title page as such, "Title Page" means
> +the text near the most prominent appearance of the work's title,
> +preceding the beginning of the body of the text.
> +
> +
> +2. VERBATIM COPYING
> +
> +You may copy and distribute the Document in any medium, either
> +commercially or noncommercially, provided that this License, the
> +copyright notices, and the license notice saying this License applies
> +to the Document are reproduced in all copies, and that you add no other
> +conditions whatsoever to those of this License. You may not use
> +technical measures to obstruct or control the reading or further
> +copying of the copies you make or distribute. However, you may accept
> +compensation in exchange for copies. If you distribute a large enough
> +number of copies you must also follow the conditions in section 3.
> +
> +You may also lend copies, under the same conditions stated above, and
> +you may publicly display copies.
> +
> +
> +3. COPYING IN QUANTITY
> +
> +If you publish printed copies of the Document numbering more than 100,
> +and the Document's license notice requires Cover Texts, you must enclose
> +the copies in covers that carry, clearly and legibly, all these Cover
> +Texts: Front-Cover Texts on the front cover, and Back-Cover Texts on
> +the back cover. Both covers must also clearly and legibly identify
> +you as the publisher of these copies. The front cover must present
> +the full title with all words of the title equally prominent and
> +visible. You may add other material on the covers in addition.
> +Copying with changes limited to the covers, as long as they preserve
> +the title of the Document and satisfy these conditions, can be treated
> +as verbatim copying in other respects.
> +
> +If the required texts for either cover are too voluminous to fit
> +legibly, you should put the first ones listed (as many as fit
> +reasonably) on the actual cover, and continue the rest onto adjacent
> +pages.
> +
> +If you publish or distribute Opaque copies of the Document numbering
> +more than 100, you must either include a machine-readable Transparent
> +copy along with each Opaque copy, or state in or with each Opaque copy
> +a publicly-accessible computer-network location containing a complete
> +Transparent copy of the Document, free of added material, which the
> +general network-using public has access to download anonymously at no
> +charge using public-standard network protocols. If you use the latter
> +option, you must take reasonably prudent steps, when you begin
> +distribution of Opaque copies in quantity, to ensure that this
> +Transparent copy will remain thus accessible at the stated location
> +until at least one year after the last time you distribute an Opaque
> +copy (directly or through your agents or retailers) of that edition to
> +the public.
> +
> +It is requested, but not required, that you contact the authors of the
> +Document well before redistributing any large number of copies, to give
> +them a chance to provide you with an updated version of the Document.
> +
> +
> +4. MODIFICATIONS
> +
> +You may copy and distribute a Modified Version of the Document under
> +the conditions of sections 2 and 3 above, provided that you release
> +the Modified Version under precisely this License, with the Modified
> +Version filling the role of the Document, thus licensing distribution
> +and modification of the Modified Version to whoever possesses a copy
> +of it. In addition, you must do these things in the Modified Version:
> +
> +A. Use in the Title Page (and on the covers, if any) a title distinct
> + from that of the Document, and from those of previous versions
> + (which should, if there were any, be listed in the History section
> + of the Document). You may use the same title as a previous version
> + if the original publisher of that version gives permission.
> +B. List on the Title Page, as authors, one or more persons or entities
> + responsible for authorship of the modifications in the Modified
> + Version, together with at least five of the principal authors of the
> + Document (all of its principal authors, if it has less than five).
> +C. State on the Title page the name of the publisher of the
> + Modified Version, as the publisher.
> +D. Preserve all the copyright notices of the Document.
> +E. Add an appropriate copyright notice for your modifications
> + adjacent to the other copyright notices.
> +F. Include, immediately after the copyright notices, a license notice
> + giving the public permission to use the Modified Version under the
> + terms of this License, in the form shown in the Addendum below.
> +G. Preserve in that license notice the full lists of Invariant Sections
> + and required Cover Texts given in the Document's license notice.
> +H. Include an unaltered copy of this License.
> +I. Preserve the section entitled "History", and its title, and add to
> + it an item stating at least the title, year, new authors, and
> + publisher of the Modified Version as given on the Title Page. If
> + there is no section entitled "History" in the Document, create one
> + stating the title, year, authors, and publisher of the Document as
> + given on its Title Page, then add an item describing the Modified
> + Version as stated in the previous sentence.
> +J. Preserve the network location, if any, given in the Document for
> + public access to a Transparent copy of the Document, and likewise
> + the network locations given in the Document for previous versions
> + it was based on. These may be placed in the "History" section.
> + You may omit a network location for a work that was published at
> + least four years before the Document itself, or if the original
> + publisher of the version it refers to gives permission.
> +K. In any section entitled "Acknowledgements" or "Dedications",
> + preserve the section's title, and preserve in the section all the
> + substance and tone of each of the contributor acknowledgements
> + and/or dedications given therein.
> +L. Preserve all the Invariant Sections of the Document,
> + unaltered in their text and in their titles. Section numbers
> + or the equivalent are not considered part of the section titles.
> +M. Delete any section entitled "Endorsements". Such a section
> + may not be included in the Modified Version.
> +N. Do not retitle any existing section as "Endorsements"
> + or to conflict in title with any Invariant Section.
> +
> +If the Modified Version includes new front-matter sections or
> +appendices that qualify as Secondary Sections and contain no material
> +copied from the Document, you may at your option designate some or all
> +of these sections as invariant. To do this, add their titles to the
> +list of Invariant Sections in the Modified Version's license notice.
> +These titles must be distinct from any other section titles.
> +
> +You may add a section entitled "Endorsements", provided it contains
> +nothing but endorsements of your Modified Version by various
> +parties--for example, statements of peer review or that the text has
> +been approved by an organization as the authoritative definition of a
> +standard.
> +
> +You may add a passage of up to five words as a Front-Cover Text, and a
> +passage of up to 25 words as a Back-Cover Text, to the end of the list
> +of Cover Texts in the Modified Version. Only one passage of
> +Front-Cover Text and one of Back-Cover Text may be added by (or
> +through arrangements made by) any one entity. If the Document already
> +includes a cover text for the same cover, previously added by you or
> +by arrangement made by the same entity you are acting on behalf of,
> +you may not add another; but you may replace the old one, on explicit
> +permission from the previous publisher that added the old one.
> +
> +The author(s) and publisher(s) of the Document do not by this License
> +give permission to use their names for publicity for or to assert or
> +imply endorsement of any Modified Version.
> +
> +
> +5. COMBINING DOCUMENTS
> +
> +You may combine the Document with other documents released under this
> +License, under the terms defined in section 4 above for modified
> +versions, provided that you include in the combination all of the
> +Invariant Sections of all of the original documents, unmodified, and
> +list them all as Invariant Sections of your combined work in its
> +license notice.
> +
> +The combined work need only contain one copy of this License, and
> +multiple identical Invariant Sections may be replaced with a single
> +copy. If there are multiple Invariant Sections with the same name but
> +different contents, make the title of each such section unique by
> +adding at the end of it, in parentheses, the name of the original
> +author or publisher of that section if known, or else a unique number.
> +Make the same adjustment to the section titles in the list of
> +Invariant Sections in the license notice of the combined work.
> +
> +In the combination, you must combine any sections entitled "History"
> +in the various original documents, forming one section entitled
> +"History"; likewise combine any sections entitled "Acknowledgements",
> +and any sections entitled "Dedications". You must delete all sections
> +entitled "Endorsements."
> +
> +
> +6. COLLECTIONS OF DOCUMENTS
> +
> +You may make a collection consisting of the Document and other documents
> +released under this License, and replace the individual copies of this
> +License in the various documents with a single copy that is included in
> +the collection, provided that you follow the rules of this License for
> +verbatim copying of each of the documents in all other respects.
> +
> +You may extract a single document from such a collection, and distribute
> +it individually under this License, provided you insert a copy of this
> +License into the extracted document, and follow this License in all
> +other respects regarding verbatim copying of that document.
> +
> +
> +7. AGGREGATION WITH INDEPENDENT WORKS
> +
> +A compilation of the Document or its derivatives with other separate
> +and independent documents or works, in or on a volume of a storage or
> +distribution medium, does not as a whole count as a Modified Version
> +of the Document, provided no compilation copyright is claimed for the
> +compilation. Such a compilation is called an "aggregate", and this
> +License does not apply to the other self-contained works thus compiled
> +with the Document, on account of their being thus compiled, if they
> +are not themselves derivative works of the Document.
> +
> +If the Cover Text requirement of section 3 is applicable to these
> +copies of the Document, then if the Document is less than one quarter
> +of the entire aggregate, the Document's Cover Texts may be placed on
> +covers that surround only the Document within the aggregate.
> +Otherwise they must appear on covers around the whole aggregate.
> +
> +
> +8. TRANSLATION
> +
> +Translation is considered a kind of modification, so you may
> +distribute translations of the Document under the terms of section 4.
> +Replacing Invariant Sections with translations requires special
> +permission from their copyright holders, but you may include
> +translations of some or all Invariant Sections in addition to the
> +original versions of these Invariant Sections. You may include a
> +translation of this License provided that you also include the
> +original English version of this License. In case of a disagreement
> +between the translation and the original English version of this
> +License, the original English version will prevail.
> +
> +
> +9. TERMINATION
> +
> +You may not copy, modify, sublicense, or distribute the Document except
> +as expressly provided for under this License. Any other attempt to
> +copy, modify, sublicense or distribute the Document is void, and will
> +automatically terminate your rights under this License. However,
> +parties who have received copies, or rights, from you under this
> +License will not have their licenses terminated so long as such
> +parties remain in full compliance.
> +
> +
> +10. FUTURE REVISIONS OF THIS LICENSE
> +
> +The Free Software Foundation may publish new, revised versions
> +of the GNU Free Documentation License from time to time. Such new
> +versions will be similar in spirit to the present version, but may
> +differ in detail to address new problems or concerns. See
> +https://www.gnu.org/licenses/.
> +
> +Each version of the License is given a distinguishing version number.
> +If the Document specifies that a particular numbered version of this
> +License "or any later version" applies to it, you have the option of
> +following the terms and conditions either of that specified version or
> +of any later version that has been published (not as a draft) by the
> +Free Software Foundation. If the Document does not specify a version
> +number of this License, you may choose any version ever published (not
> +as a draft) by the Free Software Foundation.
> +
> +
> +ADDENDUM: How to use this License for your documents
> +
> +To use this License in a document you have written, include a copy of
> +the License in the document and put the following copyright and
> +license notices just after the title page:
> +
> + Copyright (c) YEAR YOUR NAME.
> + Permission is granted to copy, distribute and/or modify this document
> + under the terms of the GNU Free Documentation License, Version 1.1
> + or any later version published by the Free Software Foundation;
> + with the Invariant Sections being LIST THEIR TITLES, with the
> + Front-Cover Texts being LIST, and with the Back-Cover Texts being LIST.
> + A copy of the license is included in the section entitled "GNU
> + Free Documentation License".
> +
> +If you have no Invariant Sections, write "with no Invariant Sections"
> +instead of saying which ones are invariant. If you have no
> +Front-Cover Texts, write "no Front-Cover Texts" instead of
> +"Front-Cover Texts being LIST"; likewise for Back-Cover Texts.
> +
> +If your document contains nontrivial examples of program code, we
> +recommend releasing these examples in parallel under your choice of
> +free software license, such as the GNU General Public License,
> +to permit their use in free software.
> diff --git a/LICENSES/deprecated/GFDL-1.2 b/LICENSES/deprecated/GFDL-1.2
> new file mode 100644
> index 000000000000..760b2568fde5
> --- /dev/null
> +++ b/LICENSES/deprecated/GFDL-1.2
> @@ -0,0 +1,408 @@
> +Valid-License-Identifier: GFDL-1.2-only-no-invariants
see above - I believe it should be GFDL-1.2-no-invariants-only, but
we need to sort this on the SPDX legal list before it gets applied.
> +SPDX-URL: https://github.com/spdx/license-list-XML/pull/1048/commits/f695d2ac65230d0f4161ba58fff2f9d87bb5a053#diff-b948674e5c5cf6341e44e76b2565e80c
> +Usage-Guide:
> + The GNU Free Documentation License with no Invariant Sections,
> + no Front-Cover Texts, and no Back-Cover Texts should not be used in new
> + code, except when dual-licensed with GPLv2.
> + To use the license in source code, put the following SPDX tag/value pair
> + into a comment according to the placement guidelines in the licensing
> + rules documentation:
> + SPDX-License-Identifier: GFDL-1.2-only-no-invariants
> +License-Text:
> + GNU Free Documentation License
> + Version 1.2, November 2002
> +
> +
> + Copyright (C) 2000,2001,2002 Free Software Foundation, Inc.
> + 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
> + Everyone is permitted to copy and distribute verbatim copies
> + of this license document, but changing it is not allowed.
> +
> +
> +0. PREAMBLE
> +
> +The purpose of this License is to make a manual, textbook, or other
> +functional and useful document "free" in the sense of freedom: to
> +assure everyone the effective freedom to copy and redistribute it,
> +with or without modifying it, either commercially or noncommercially.
> +Secondarily, this License preserves for the author and publisher a way
> +to get credit for their work, while not being considered responsible
> +for modifications made by others.
> +
> +This License is a kind of "copyleft", which means that derivative
> +works of the document must themselves be free in the same sense. It
> +complements the GNU General Public License, which is a copyleft
> +license designed for free software.
> +
> +We have designed this License in order to use it for manuals for free
> +software, because free software needs free documentation: a free
> +program should come with manuals providing the same freedoms that the
> +software does. But this License is not limited to software manuals;
> +it can be used for any textual work, regardless of subject matter or
> +whether it is published as a printed book. We recommend this License
> +principally for works whose purpose is instruction or reference.
> +
> +
> +1. APPLICABILITY AND DEFINITIONS
> +
> +This License applies to any manual or other work, in any medium, that
> +contains a notice placed by the copyright holder saying it can be
> +distributed under the terms of this License. Such a notice grants a
> +world-wide, royalty-free license, unlimited in duration, to use that
> +work under the conditions stated herein. The "Document", below,
> +refers to any such manual or work. Any member of the public is a
> +licensee, and is addressed as "you". You accept the license if you
> +copy, modify or distribute the work in a way requiring permission
> +under copyright law.
> +
> +A "Modified Version" of the Document means any work containing the
> +Document or a portion of it, either copied verbatim, or with
> +modifications and/or translated into another language.
> +
> +A "Secondary Section" is a named appendix or a front-matter section of
> +the Document that deals exclusively with the relationship of the
> +publishers or authors of the Document to the Document's overall subject
> +(or to related matters) and contains nothing that could fall directly
> +within that overall subject. (Thus, if the Document is in part a
> +textbook of mathematics, a Secondary Section may not explain any
> +mathematics.) The relationship could be a matter of historical
> +connection with the subject or with related matters, or of legal,
> +commercial, philosophical, ethical or political position regarding
> +them.
> +
> +The "Invariant Sections" are certain Secondary Sections whose titles
> +are designated, as being those of Invariant Sections, in the notice
> +that says that the Document is released under this License. If a
> +section does not fit the above definition of Secondary then it is not
> +allowed to be designated as Invariant. The Document may contain zero
> +Invariant Sections. If the Document does not identify any Invariant
> +Sections then there are none.
> +
> +The "Cover Texts" are certain short passages of text that are listed,
> +as Front-Cover Texts or Back-Cover Texts, in the notice that says that
> +the Document is released under this License. A Front-Cover Text may
> +be at most 5 words, and a Back-Cover Text may be at most 25 words.
> +
> +A "Transparent" copy of the Document means a machine-readable copy,
> +represented in a format whose specification is available to the
> +general public, that is suitable for revising the document
> +straightforwardly with generic text editors or (for images composed of
> +pixels) generic paint programs or (for drawings) some widely available
> +drawing editor, and that is suitable for input to text formatters or
> +for automatic translation to a variety of formats suitable for input
> +to text formatters. A copy made in an otherwise Transparent file
> +format whose markup, or absence of markup, has been arranged to thwart
> +or discourage subsequent modification by readers is not Transparent.
> +An image format is not Transparent if used for any substantial amount
> +of text. A copy that is not "Transparent" is called "Opaque".
> +
> +Examples of suitable formats for Transparent copies include plain
> +ASCII without markup, Texinfo input format, LaTeX input format, SGML
> +or XML using a publicly available DTD, and standard-conforming simple
> +HTML, PostScript or PDF designed for human modification. Examples of
> +transparent image formats include PNG, XCF and JPG. Opaque formats
> +include proprietary formats that can be read and edited only by
> +proprietary word processors, SGML or XML for which the DTD and/or
> +processing tools are not generally available, and the
> +machine-generated HTML, PostScript or PDF produced by some word
> +processors for output purposes only.
> +
> +The "Title Page" means, for a printed book, the title page itself,
> +plus such following pages as are needed to hold, legibly, the material
> +this License requires to appear in the title page. For works in
> +formats which do not have any title page as such, "Title Page" means
> +the text near the most prominent appearance of the work's title,
> +preceding the beginning of the body of the text.
> +
> +A section "Entitled XYZ" means a named subunit of the Document whose
> +title either is precisely XYZ or contains XYZ in parentheses following
> +text that translates XYZ in another language. (Here XYZ stands for a
> +specific section name mentioned below, such as "Acknowledgements",
> +"Dedications", "Endorsements", or "History".) To "Preserve the Title"
> +of such a section when you modify the Document means that it remains a
> +section "Entitled XYZ" according to this definition.
> +
> +The Document may include Warranty Disclaimers next to the notice which
> +states that this License applies to the Document. These Warranty
> +Disclaimers are considered to be included by reference in this
> +License, but only as regards disclaiming warranties: any other
> +implication that these Warranty Disclaimers may have is void and has
> +no effect on the meaning of this License.
> +
> +
> +2. VERBATIM COPYING
> +
> +You may copy and distribute the Document in any medium, either
> +commercially or noncommercially, provided that this License, the
> +copyright notices, and the license notice saying this License applies
> +to the Document are reproduced in all copies, and that you add no other
> +conditions whatsoever to those of this License. You may not use
> +technical measures to obstruct or control the reading or further
> +copying of the copies you make or distribute. However, you may accept
> +compensation in exchange for copies. If you distribute a large enough
> +number of copies you must also follow the conditions in section 3.
> +
> +You may also lend copies, under the same conditions stated above, and
> +you may publicly display copies.
> +
> +
> +3. COPYING IN QUANTITY
> +
> +If you publish printed copies (or copies in media that commonly have
> +printed covers) of the Document, numbering more than 100, and the
> +Document's license notice requires Cover Texts, you must enclose the
> +copies in covers that carry, clearly and legibly, all these Cover
> +Texts: Front-Cover Texts on the front cover, and Back-Cover Texts on
> +the back cover. Both covers must also clearly and legibly identify
> +you as the publisher of these copies. The front cover must present
> +the full title with all words of the title equally prominent and
> +visible. You may add other material on the covers in addition.
> +Copying with changes limited to the covers, as long as they preserve
> +the title of the Document and satisfy these conditions, can be treated
> +as verbatim copying in other respects.
> +
> +If the required texts for either cover are too voluminous to fit
> +legibly, you should put the first ones listed (as many as fit
> +reasonably) on the actual cover, and continue the rest onto adjacent
> +pages.
> +
> +If you publish or distribute Opaque copies of the Document numbering
> +more than 100, you must either include a machine-readable Transparent
> +copy along with each Opaque copy, or state in or with each Opaque copy
> +a computer-network location from which the general network-using
> +public has access to download using public-standard network protocols
> +a complete Transparent copy of the Document, free of added material.
> +If you use the latter option, you must take reasonably prudent steps,
> +when you begin distribution of Opaque copies in quantity, to ensure
> +that this Transparent copy will remain thus accessible at the stated
> +location until at least one year after the last time you distribute an
> +Opaque copy (directly or through your agents or retailers) of that
> +edition to the public.
> +
> +It is requested, but not required, that you contact the authors of the
> +Document well before redistributing any large number of copies, to give
> +them a chance to provide you with an updated version of the Document.
> +
> +
> +4. MODIFICATIONS
> +
> +You may copy and distribute a Modified Version of the Document under
> +the conditions of sections 2 and 3 above, provided that you release
> +the Modified Version under precisely this License, with the Modified
> +Version filling the role of the Document, thus licensing distribution
> +and modification of the Modified Version to whoever possesses a copy
> +of it. In addition, you must do these things in the Modified Version:
> +
> +A. Use in the Title Page (and on the covers, if any) a title distinct
> + from that of the Document, and from those of previous versions
> + (which should, if there were any, be listed in the History section
> + of the Document). You may use the same title as a previous version
> + if the original publisher of that version gives permission.
> +B. List on the Title Page, as authors, one or more persons or entities
> + responsible for authorship of the modifications in the Modified
> + Version, together with at least five of the principal authors of the
> + Document (all of its principal authors, if it has fewer than five),
> + unless they release you from this requirement.
> +C. State on the Title page the name of the publisher of the
> + Modified Version, as the publisher.
> +D. Preserve all the copyright notices of the Document.
> +E. Add an appropriate copyright notice for your modifications
> + adjacent to the other copyright notices.
> +F. Include, immediately after the copyright notices, a license notice
> + giving the public permission to use the Modified Version under the
> + terms of this License, in the form shown in the Addendum below.
> +G. Preserve in that license notice the full lists of Invariant Sections
> + and required Cover Texts given in the Document's license notice.
> +H. Include an unaltered copy of this License.
> +I. Preserve the section Entitled "History", Preserve its Title, and add
> + to it an item stating at least the title, year, new authors, and
> + publisher of the Modified Version as given on the Title Page. If
> + there is no section Entitled "History" in the Document, create one
> + stating the title, year, authors, and publisher of the Document as
> + given on its Title Page, then add an item describing the Modified
> + Version as stated in the previous sentence.
> +J. Preserve the network location, if any, given in the Document for
> + public access to a Transparent copy of the Document, and likewise
> + the network locations given in the Document for previous versions
> + it was based on. These may be placed in the "History" section.
> + You may omit a network location for a work that was published at
> + least four years before the Document itself, or if the original
> + publisher of the version it refers to gives permission.
> +K. For any section Entitled "Acknowledgements" or "Dedications",
> + Preserve the Title of the section, and preserve in the section all
> + the substance and tone of each of the contributor acknowledgements
> + and/or dedications given therein.
> +L. Preserve all the Invariant Sections of the Document,
> + unaltered in their text and in their titles. Section numbers
> + or the equivalent are not considered part of the section titles.
> +M. Delete any section Entitled "Endorsements". Such a section
> + may not be included in the Modified Version.
> +N. Do not retitle any existing section to be Entitled "Endorsements"
> + or to conflict in title with any Invariant Section.
> +O. Preserve any Warranty Disclaimers.
> +
> +If the Modified Version includes new front-matter sections or
> +appendices that qualify as Secondary Sections and contain no material
> +copied from the Document, you may at your option designate some or all
> +of these sections as invariant. To do this, add their titles to the
> +list of Invariant Sections in the Modified Version's license notice.
> +These titles must be distinct from any other section titles.
> +
> +You may add a section Entitled "Endorsements", provided it contains
> +nothing but endorsements of your Modified Version by various
> +parties--for example, statements of peer review or that the text has
> +been approved by an organization as the authoritative definition of a
> +standard.
> +
> +You may add a passage of up to five words as a Front-Cover Text, and a
> +passage of up to 25 words as a Back-Cover Text, to the end of the list
> +of Cover Texts in the Modified Version. Only one passage of
> +Front-Cover Text and one of Back-Cover Text may be added by (or
> +through arrangements made by) any one entity. If the Document already
> +includes a cover text for the same cover, previously added by you or
> +by arrangement made by the same entity you are acting on behalf of,
> +you may not add another; but you may replace the old one, on explicit
> +permission from the previous publisher that added the old one.
> +
> +The author(s) and publisher(s) of the Document do not by this License
> +give permission to use their names for publicity for or to assert or
> +imply endorsement of any Modified Version.
> +
> +
> +5. COMBINING DOCUMENTS
> +
> +You may combine the Document with other documents released under this
> +License, under the terms defined in section 4 above for modified
> +versions, provided that you include in the combination all of the
> +Invariant Sections of all of the original documents, unmodified, and
> +list them all as Invariant Sections of your combined work in its
> +license notice, and that you preserve all their Warranty Disclaimers.
> +
> +The combined work need only contain one copy of this License, and
> +multiple identical Invariant Sections may be replaced with a single
> +copy. If there are multiple Invariant Sections with the same name but
> +different contents, make the title of each such section unique by
> +adding at the end of it, in parentheses, the name of the original
> +author or publisher of that section if known, or else a unique number.
> +Make the same adjustment to the section titles in the list of
> +Invariant Sections in the license notice of the combined work.
> +
> +In the combination, you must combine any sections Entitled "History"
> +in the various original documents, forming one section Entitled
> +"History"; likewise combine any sections Entitled "Acknowledgements",
> +and any sections Entitled "Dedications". You must delete all sections
> +Entitled "Endorsements".
> +
> +
> +6. COLLECTIONS OF DOCUMENTS
> +
> +You may make a collection consisting of the Document and other documents
> +released under this License, and replace the individual copies of this
> +License in the various documents with a single copy that is included in
> +the collection, provided that you follow the rules of this License for
> +verbatim copying of each of the documents in all other respects.
> +
> +You may extract a single document from such a collection, and distribute
> +it individually under this License, provided you insert a copy of this
> +License into the extracted document, and follow this License in all
> +other respects regarding verbatim copying of that document.
> +
> +
> +7. AGGREGATION WITH INDEPENDENT WORKS
> +
> +A compilation of the Document or its derivatives with other separate
> +and independent documents or works, in or on a volume of a storage or
> +distribution medium, is called an "aggregate" if the copyright
> +resulting from the compilation is not used to limit the legal rights
> +of the compilation's users beyond what the individual works permit.
> +When the Document is included in an aggregate, this License does not
> +apply to the other works in the aggregate which are not themselves
> +derivative works of the Document.
> +
> +If the Cover Text requirement of section 3 is applicable to these
> +copies of the Document, then if the Document is less than one half of
> +the entire aggregate, the Document's Cover Texts may be placed on
> +covers that bracket the Document within the aggregate, or the
> +electronic equivalent of covers if the Document is in electronic form.
> +Otherwise they must appear on printed covers that bracket the whole
> +aggregate.
> +
> +
> +8. TRANSLATION
> +
> +Translation is considered a kind of modification, so you may
> +distribute translations of the Document under the terms of section 4.
> +Replacing Invariant Sections with translations requires special
> +permission from their copyright holders, but you may include
> +translations of some or all Invariant Sections in addition to the
> +original versions of these Invariant Sections. You may include a
> +translation of this License, and all the license notices in the
> +Document, and any Warranty Disclaimers, provided that you also include
> +the original English version of this License and the original versions
> +of those notices and disclaimers. In case of a disagreement between
> +the translation and the original version of this License or a notice
> +or disclaimer, the original version will prevail.
> +
> +If a section in the Document is Entitled "Acknowledgements",
> +"Dedications", or "History", the requirement (section 4) to Preserve
> +its Title (section 1) will typically require changing the actual
> +title.
> +
> +
> +9. TERMINATION
> +
> +You may not copy, modify, sublicense, or distribute the Document except
> +as expressly provided for under this License. Any other attempt to
> +copy, modify, sublicense or distribute the Document is void, and will
> +automatically terminate your rights under this License. However,
> +parties who have received copies, or rights, from you under this
> +License will not have their licenses terminated so long as such
> +parties remain in full compliance.
> +
> +
> +10. FUTURE REVISIONS OF THIS LICENSE
> +
> +The Free Software Foundation may publish new, revised versions
> +of the GNU Free Documentation License from time to time. Such new
> +versions will be similar in spirit to the present version, but may
> +differ in detail to address new problems or concerns. See
> +https://www.gnu.org/licenses/.
> +
> +Each version of the License is given a distinguishing version number.
> +If the Document specifies that a particular numbered version of this
> +License "or any later version" applies to it, you have the option of
> +following the terms and conditions either of that specified version or
> +of any later version that has been published (not as a draft) by the
> +Free Software Foundation. If the Document does not specify a version
> +number of this License, you may choose any version ever published (not
> +as a draft) by the Free Software Foundation.
> +
> +
> +ADDENDUM: How to use this License for your documents
> +
> +To use this License in a document you have written, include a copy of
> +the License in the document and put the following copyright and
> +license notices just after the title page:
> +
> + Copyright (c) YEAR YOUR NAME.
> + Permission is granted to copy, distribute and/or modify this document
> + under the terms of the GNU Free Documentation License, Version 1.2
> + or any later version published by the Free Software Foundation;
> + with no Invariant Sections, no Front-Cover Texts, and no Back-Cover Texts.
> + A copy of the license is included in the section entitled "GNU
> + Free Documentation License".
> +
> +If you have Invariant Sections, Front-Cover Texts and Back-Cover Texts,
> +replace the "with...Texts." line with this:
> +
> + with the Invariant Sections being LIST THEIR TITLES, with the
> + Front-Cover Texts being LIST, and with the Back-Cover Texts being LIST.
> +
> +If you have Invariant Sections without Cover Texts, or some other
> +combination of the three, merge those two alternatives to suit the
> +situation.
> +
> +If your document contains nontrivial examples of program code, we
> +recommend releasing these examples in parallel under your choice of
> +free software license, such as the GNU General Public License,
> +to permit their use in free software.
> --
> 2.26.2
>
Please hold off on applying this until the details of the SPDX
identifier are resolved.
Thanks, Kate
^ permalink raw reply [flat|nested] 15+ messages in thread
* Re: [PATCH v2 0/9] Convert the remaining text files to ReST and add SPDX for GFDL
2020-06-23 9:52 [PATCH v2 0/9] Convert the remaining text files to ReST and add SPDX for GFDL Mauro Carvalho Chehab
` (7 preceding siblings ...)
2020-06-23 9:53 ` [PATCH v2 9/9] docs: staging: use small font for literal includes Mauro Carvalho Chehab
@ 2020-06-23 11:58 ` Kate Stewart
2020-06-23 13:37 ` Mauro Carvalho Chehab
8 siblings, 1 reply; 15+ messages in thread
From: Kate Stewart @ 2020-06-23 11:58 UTC (permalink / raw)
To: Mauro Carvalho Chehab
Cc: Linux Doc Mailing List, LKML, Jonathan Corbet, Bingbu Cao,
Maxime Ripard, Yong Zhi, Thomas Gleixner, Tian Shu Qiu,
Rob Herring, devicetree, linux-spdx, linux-mm, linux-media,
dri-devel, Greg Kroah-Hartman, Andrew Morton, Sakari Ailus,
Harry Wei, David Airlie, Maarten Lankhorst, Daniel Vetter,
Thomas Zimmermann, Hans Verkuil, Alex Shi
On Tue, Jun 23, 2020 at 4:53 AM Mauro Carvalho Chehab
<mchehab+huawei@kernel.org> wrote:
>
> The main goal of this series is to finish the ReST conversion. After this
> series, we have just those files still in plain old format:
>
> - Documentation/RCU/RTFP.txt
> - Documentation/atomic_bitops.txt
> - Documentation/memory-barriers.txt
> - Documentation/atomic_t.txt
> - Documentation/filesystems/dax.txt
> - Documentation/filesystems/path-lookup.txt
> - Documentation/virt/kvm/devices/README
>
> PS.: I'm using a script to remove false-positives and ignore non-converted
> translated files.
>
> It is worth to mention that this fseries contain licenses for the two
> GFDL licenses used within the Kernel: GFDL-1.1+ and GFDL-1.2.
>
> Those licenses are the result of long discussions with the SPDX legal
> team, and are part of this commit, to be added for the future
> SPDX 3.10 version:
> https://github.com/spdx/license-list-XML/pull/1048/commits/f695d2ac65230d0f4161ba58fff2f9d87bb5a053
>
> Mauro Carvalho Chehab (9):
> docs: dt: convert booting-without-of.txt to ReST format
> LICENSES: add GFDL licenses
> media: docs: use SPDX GFDL-1.1-or-later-no-invariants
The identifier "GFDL-1.1-or-later-no-invariants" isn't following expected
construction (or-later and -only at the end) and the pull request is
still under
discussion on the SPDX license list, so please hold off on applying this
until the correct identifier is figured out there.
> docs: trace: ring-buffer-design.txt: convert to ReST format
> docs: move nommu-mmap.txt to admin-guide and rename to ReST
> docs: move mailbox.txt to driver-api and rename it
> docs: move other kAPI documents to core-api
> docs: Add remaining Documentation/*.txt at staging/index.rst
> docs: staging: use small font for literal includes
>
> Documentation/admin-guide/mm/index.rst | 1 +
> .../mm/nommu-mmap.rst} | 0
> Documentation/admin-guide/sysctl/vm.rst | 2 +-
> Documentation/arm/booting.rst | 2 +-
> .../bus-virt-phys-mapping.rst} | 0
> Documentation/core-api/index.rst | 3 +
> .../this_cpu_ops.rst} | 0
> .../unaligned-memory-access.rst | 0
> ...-without-of.txt => booting-without-of.rst} | 298 ++++---
> Documentation/devicetree/index.rst | 1 +
> Documentation/driver-api/index.rst | 1 +
> .../{mailbox.txt => driver-api/mailbox.rst} | 0
> Documentation/gpu/drm-mm.rst | 2 +-
> Documentation/staging/index.rst | 24 +
> Documentation/trace/index.rst | 1 +
> ...ffer-design.txt => ring-buffer-design.rst} | 778 +++++++++---------
> Documentation/translations/zh_CN/arm/Booting | 2 +-
> .../userspace-api/media/cec/cec-api.rst | 9 +-
> .../media/cec/cec-func-close.rst | 9 +-
> .../media/cec/cec-func-ioctl.rst | 9 +-
> .../userspace-api/media/cec/cec-func-open.rst | 9 +-
> .../userspace-api/media/cec/cec-func-poll.rst | 9 +-
> .../userspace-api/media/cec/cec-funcs.rst | 9 +-
> .../userspace-api/media/cec/cec-header.rst | 9 +-
> .../userspace-api/media/cec/cec-intro.rst | 9 +-
> .../media/cec/cec-ioc-adap-g-caps.rst | 9 +-
> .../media/cec/cec-ioc-adap-g-log-addrs.rst | 9 +-
> .../media/cec/cec-ioc-adap-g-phys-addr.rst | 9 +-
> .../media/cec/cec-ioc-dqevent.rst | 9 +-
> .../media/cec/cec-ioc-g-mode.rst | 9 +-
> .../media/cec/cec-ioc-receive.rst | 9 +-
> .../media/cec/cec-pin-error-inj.rst | 9 +-
> .../dvb/audio-bilingual-channel-select.rst | 9 +-
> .../media/dvb/audio-channel-select.rst | 9 +-
> .../media/dvb/audio-clear-buffer.rst | 9 +-
> .../media/dvb/audio-continue.rst | 9 +-
> .../userspace-api/media/dvb/audio-fclose.rst | 9 +-
> .../userspace-api/media/dvb/audio-fopen.rst | 9 +-
> .../userspace-api/media/dvb/audio-fwrite.rst | 9 +-
> .../media/dvb/audio-get-capabilities.rst | 9 +-
> .../media/dvb/audio-get-status.rst | 9 +-
> .../userspace-api/media/dvb/audio-pause.rst | 9 +-
> .../userspace-api/media/dvb/audio-play.rst | 9 +-
> .../media/dvb/audio-select-source.rst | 9 +-
> .../media/dvb/audio-set-av-sync.rst | 9 +-
> .../media/dvb/audio-set-bypass-mode.rst | 9 +-
> .../userspace-api/media/dvb/audio-set-id.rst | 9 +-
> .../media/dvb/audio-set-mixer.rst | 9 +-
> .../media/dvb/audio-set-mute.rst | 9 +-
> .../media/dvb/audio-set-streamtype.rst | 9 +-
> .../userspace-api/media/dvb/audio-stop.rst | 9 +-
> .../userspace-api/media/dvb/audio.rst | 9 +-
> .../media/dvb/audio_data_types.rst | 9 +-
> .../media/dvb/audio_function_calls.rst | 9 +-
> .../userspace-api/media/dvb/ca-fclose.rst | 9 +-
> .../userspace-api/media/dvb/ca-fopen.rst | 9 +-
> .../userspace-api/media/dvb/ca-get-cap.rst | 9 +-
> .../media/dvb/ca-get-descr-info.rst | 9 +-
> .../userspace-api/media/dvb/ca-get-msg.rst | 9 +-
> .../media/dvb/ca-get-slot-info.rst | 9 +-
> .../userspace-api/media/dvb/ca-reset.rst | 9 +-
> .../userspace-api/media/dvb/ca-send-msg.rst | 9 +-
> .../userspace-api/media/dvb/ca-set-descr.rst | 9 +-
> Documentation/userspace-api/media/dvb/ca.rst | 9 +-
> .../userspace-api/media/dvb/ca_data_types.rst | 9 +-
> .../media/dvb/ca_function_calls.rst | 9 +-
> .../userspace-api/media/dvb/demux.rst | 9 +-
> .../userspace-api/media/dvb/dmx-add-pid.rst | 9 +-
> .../userspace-api/media/dvb/dmx-expbuf.rst | 9 +-
> .../userspace-api/media/dvb/dmx-fclose.rst | 9 +-
> .../userspace-api/media/dvb/dmx-fopen.rst | 9 +-
> .../userspace-api/media/dvb/dmx-fread.rst | 9 +-
> .../userspace-api/media/dvb/dmx-fwrite.rst | 9 +-
> .../media/dvb/dmx-get-pes-pids.rst | 9 +-
> .../userspace-api/media/dvb/dmx-get-stc.rst | 9 +-
> .../userspace-api/media/dvb/dmx-mmap.rst | 9 +-
> .../userspace-api/media/dvb/dmx-munmap.rst | 9 +-
> .../userspace-api/media/dvb/dmx-qbuf.rst | 9 +-
> .../userspace-api/media/dvb/dmx-querybuf.rst | 9 +-
> .../media/dvb/dmx-remove-pid.rst | 9 +-
> .../userspace-api/media/dvb/dmx-reqbufs.rst | 9 +-
> .../media/dvb/dmx-set-buffer-size.rst | 9 +-
> .../media/dvb/dmx-set-filter.rst | 9 +-
> .../media/dvb/dmx-set-pes-filter.rst | 9 +-
> .../userspace-api/media/dvb/dmx-start.rst | 9 +-
> .../userspace-api/media/dvb/dmx-stop.rst | 9 +-
> .../userspace-api/media/dvb/dmx_fcalls.rst | 9 +-
> .../userspace-api/media/dvb/dmx_types.rst | 9 +-
> .../media/dvb/dvb-fe-read-status.rst | 9 +-
> .../media/dvb/dvb-frontend-event.rst | 9 +-
> .../media/dvb/dvb-frontend-parameters.rst | 9 +-
> .../userspace-api/media/dvb/dvbapi.rst | 9 +-
> .../userspace-api/media/dvb/dvbproperty.rst | 9 +-
> .../userspace-api/media/dvb/examples.rst | 9 +-
> .../media/dvb/fe-bandwidth-t.rst | 9 +-
> .../media/dvb/fe-diseqc-recv-slave-reply.rst | 9 +-
> .../media/dvb/fe-diseqc-reset-overload.rst | 9 +-
> .../media/dvb/fe-diseqc-send-burst.rst | 9 +-
> .../media/dvb/fe-diseqc-send-master-cmd.rst | 9 +-
> .../dvb/fe-dishnetwork-send-legacy-cmd.rst | 9 +-
> .../media/dvb/fe-enable-high-lnb-voltage.rst | 9 +-
> .../userspace-api/media/dvb/fe-get-event.rst | 9 +-
> .../media/dvb/fe-get-frontend.rst | 9 +-
> .../userspace-api/media/dvb/fe-get-info.rst | 9 +-
> .../media/dvb/fe-get-property.rst | 9 +-
> .../userspace-api/media/dvb/fe-read-ber.rst | 9 +-
> .../media/dvb/fe-read-signal-strength.rst | 9 +-
> .../userspace-api/media/dvb/fe-read-snr.rst | 9 +-
> .../media/dvb/fe-read-status.rst | 9 +-
> .../media/dvb/fe-read-uncorrected-blocks.rst | 9 +-
> .../media/dvb/fe-set-frontend-tune-mode.rst | 9 +-
> .../media/dvb/fe-set-frontend.rst | 9 +-
> .../userspace-api/media/dvb/fe-set-tone.rst | 9 +-
> .../media/dvb/fe-set-voltage.rst | 9 +-
> .../userspace-api/media/dvb/fe-type-t.rst | 9 +-
> .../media/dvb/fe_property_parameters.rst | 9 +-
> .../media/dvb/frontend-header.rst | 9 +-
> .../dvb/frontend-property-cable-systems.rst | 9 +-
> .../frontend-property-satellite-systems.rst | 9 +-
> .../frontend-property-terrestrial-systems.rst | 9 +-
> .../media/dvb/frontend-stat-properties.rst | 9 +-
> .../userspace-api/media/dvb/frontend.rst | 9 +-
> .../media/dvb/frontend_f_close.rst | 9 +-
> .../media/dvb/frontend_f_open.rst | 9 +-
> .../media/dvb/frontend_fcalls.rst | 9 +-
> .../media/dvb/frontend_legacy_api.rst | 9 +-
> .../media/dvb/frontend_legacy_dvbv3_api.rst | 9 +-
> .../userspace-api/media/dvb/headers.rst | 9 +-
> .../userspace-api/media/dvb/intro.rst | 9 +-
> .../media/dvb/legacy_dvb_apis.rst | 9 +-
> .../userspace-api/media/dvb/net-add-if.rst | 9 +-
> .../userspace-api/media/dvb/net-get-if.rst | 9 +-
> .../userspace-api/media/dvb/net-remove-if.rst | 9 +-
> .../userspace-api/media/dvb/net-types.rst | 9 +-
> Documentation/userspace-api/media/dvb/net.rst | 9 +-
> .../media/dvb/query-dvb-frontend-info.rst | 9 +-
> .../media/dvb/video-clear-buffer.rst | 9 +-
> .../userspace-api/media/dvb/video-command.rst | 9 +-
> .../media/dvb/video-continue.rst | 9 +-
> .../media/dvb/video-fast-forward.rst | 9 +-
> .../userspace-api/media/dvb/video-fclose.rst | 9 +-
> .../userspace-api/media/dvb/video-fopen.rst | 9 +-
> .../userspace-api/media/dvb/video-freeze.rst | 9 +-
> .../userspace-api/media/dvb/video-fwrite.rst | 9 +-
> .../media/dvb/video-get-capabilities.rst | 9 +-
> .../media/dvb/video-get-event.rst | 9 +-
> .../media/dvb/video-get-frame-count.rst | 9 +-
> .../userspace-api/media/dvb/video-get-pts.rst | 9 +-
> .../media/dvb/video-get-size.rst | 9 +-
> .../media/dvb/video-get-status.rst | 9 +-
> .../userspace-api/media/dvb/video-play.rst | 9 +-
> .../media/dvb/video-select-source.rst | 9 +-
> .../media/dvb/video-set-blank.rst | 9 +-
> .../media/dvb/video-set-display-format.rst | 9 +-
> .../media/dvb/video-set-format.rst | 9 +-
> .../media/dvb/video-set-streamtype.rst | 9 +-
> .../media/dvb/video-slowmotion.rst | 9 +-
> .../media/dvb/video-stillpicture.rst | 9 +-
> .../userspace-api/media/dvb/video-stop.rst | 9 +-
> .../media/dvb/video-try-command.rst | 9 +-
> .../userspace-api/media/dvb/video.rst | 9 +-
> .../media/dvb/video_function_calls.rst | 9 +-
> .../userspace-api/media/dvb/video_types.rst | 9 +-
> .../userspace-api/media/fdl-appendix.rst | 9 +-
> .../userspace-api/media/gen-errors.rst | 9 +-
> .../media/mediactl/media-controller-intro.rst | 9 +-
> .../media/mediactl/media-controller-model.rst | 9 +-
> .../media/mediactl/media-controller.rst | 9 +-
> .../media/mediactl/media-func-close.rst | 9 +-
> .../media/mediactl/media-func-ioctl.rst | 9 +-
> .../media/mediactl/media-func-open.rst | 9 +-
> .../media/mediactl/media-funcs.rst | 9 +-
> .../media/mediactl/media-header.rst | 9 +-
> .../media/mediactl/media-ioc-device-info.rst | 9 +-
> .../mediactl/media-ioc-enum-entities.rst | 9 +-
> .../media/mediactl/media-ioc-enum-links.rst | 9 +-
> .../media/mediactl/media-ioc-g-topology.rst | 9 +-
> .../mediactl/media-ioc-request-alloc.rst | 26 +-
> .../media/mediactl/media-ioc-setup-link.rst | 9 +-
> .../mediactl/media-request-ioc-queue.rst | 26 +-
> .../mediactl/media-request-ioc-reinit.rst | 26 +-
> .../media/mediactl/media-types.rst | 9 +-
> .../media/mediactl/request-api.rst | 26 +-
> .../media/mediactl/request-func-close.rst | 26 +-
> .../media/mediactl/request-func-ioctl.rst | 26 +-
> .../media/mediactl/request-func-poll.rst | 26 +-
> .../userspace-api/media/rc/keytable.c.rst | 9 +-
> .../userspace-api/media/rc/lirc-dev-intro.rst | 9 +-
> .../userspace-api/media/rc/lirc-dev.rst | 9 +-
> .../userspace-api/media/rc/lirc-func.rst | 9 +-
> .../media/rc/lirc-get-features.rst | 9 +-
> .../media/rc/lirc-get-rec-mode.rst | 9 +-
> .../media/rc/lirc-get-rec-resolution.rst | 9 +-
> .../media/rc/lirc-get-send-mode.rst | 9 +-
> .../media/rc/lirc-get-timeout.rst | 9 +-
> .../userspace-api/media/rc/lirc-header.rst | 9 +-
> .../userspace-api/media/rc/lirc-read.rst | 9 +-
> .../rc/lirc-set-measure-carrier-mode.rst | 9 +-
> .../media/rc/lirc-set-rec-carrier-range.rst | 9 +-
> .../media/rc/lirc-set-rec-carrier.rst | 9 +-
> .../media/rc/lirc-set-rec-timeout-reports.rst | 9 +-
> .../media/rc/lirc-set-rec-timeout.rst | 9 +-
> .../media/rc/lirc-set-send-carrier.rst | 9 +-
> .../media/rc/lirc-set-send-duty-cycle.rst | 9 +-
> .../media/rc/lirc-set-transmitter-mask.rst | 9 +-
> .../media/rc/lirc-set-wideband-receiver.rst | 9 +-
> .../userspace-api/media/rc/lirc-write.rst | 9 +-
> .../userspace-api/media/rc/rc-intro.rst | 9 +-
> .../userspace-api/media/rc/rc-protos.rst | 4 +-
> .../userspace-api/media/rc/rc-sysfs-nodes.rst | 9 +-
> .../media/rc/rc-table-change.rst | 9 +-
> .../userspace-api/media/rc/rc-tables.rst | 9 +-
> .../media/rc/remote_controllers.rst | 9 +-
> .../userspace-api/media/v4l/app-pri.rst | 9 +-
> .../userspace-api/media/v4l/async.rst | 9 +-
> .../userspace-api/media/v4l/audio.rst | 9 +-
> .../userspace-api/media/v4l/biblio.rst | 9 +-
> .../userspace-api/media/v4l/buffer.rst | 9 +-
> .../media/v4l/capture-example.rst | 9 +-
> .../userspace-api/media/v4l/capture.c.rst | 9 +-
> .../media/v4l/colorspaces-defs.rst | 9 +-
> .../media/v4l/colorspaces-details.rst | 9 +-
> .../userspace-api/media/v4l/colorspaces.rst | 9 +-
> .../userspace-api/media/v4l/common-defs.rst | 9 +-
> .../userspace-api/media/v4l/common.rst | 9 +-
> .../userspace-api/media/v4l/compat.rst | 9 +-
> .../userspace-api/media/v4l/control.rst | 9 +-
> .../userspace-api/media/v4l/crop.rst | 9 +-
> .../userspace-api/media/v4l/depth-formats.rst | 9 +-
> .../userspace-api/media/v4l/dev-capture.rst | 9 +-
> .../userspace-api/media/v4l/dev-event.rst | 9 +-
> .../userspace-api/media/v4l/dev-mem2mem.rst | 9 +-
> .../userspace-api/media/v4l/dev-meta.rst | 9 +-
> .../userspace-api/media/v4l/dev-osd.rst | 9 +-
> .../userspace-api/media/v4l/dev-output.rst | 9 +-
> .../userspace-api/media/v4l/dev-overlay.rst | 9 +-
> .../userspace-api/media/v4l/dev-radio.rst | 9 +-
> .../userspace-api/media/v4l/dev-raw-vbi.rst | 9 +-
> .../userspace-api/media/v4l/dev-rds.rst | 9 +-
> .../userspace-api/media/v4l/dev-sdr.rst | 9 +-
> .../media/v4l/dev-sliced-vbi.rst | 9 +-
> .../userspace-api/media/v4l/dev-subdev.rst | 9 +-
> .../userspace-api/media/v4l/dev-touch.rst | 9 +-
> .../userspace-api/media/v4l/devices.rst | 9 +-
> .../userspace-api/media/v4l/diff-v4l.rst | 9 +-
> .../userspace-api/media/v4l/dmabuf.rst | 9 +-
> .../userspace-api/media/v4l/dv-timings.rst | 9 +-
> .../media/v4l/ext-ctrls-camera.rst | 9 +-
> .../media/v4l/ext-ctrls-codec.rst | 9 +-
> .../media/v4l/ext-ctrls-detect.rst | 9 +-
> .../userspace-api/media/v4l/ext-ctrls-dv.rst | 9 +-
> .../media/v4l/ext-ctrls-flash.rst | 9 +-
> .../media/v4l/ext-ctrls-fm-rx.rst | 9 +-
> .../media/v4l/ext-ctrls-fm-tx.rst | 9 +-
> .../media/v4l/ext-ctrls-image-process.rst | 9 +-
> .../media/v4l/ext-ctrls-image-source.rst | 9 +-
> .../media/v4l/ext-ctrls-jpeg.rst | 9 +-
> .../media/v4l/ext-ctrls-rf-tuner.rst | 9 +-
> .../media/v4l/extended-controls.rst | 9 +-
> .../userspace-api/media/v4l/field-order.rst | 9 +-
> .../userspace-api/media/v4l/format.rst | 9 +-
> .../userspace-api/media/v4l/func-close.rst | 9 +-
> .../userspace-api/media/v4l/func-ioctl.rst | 9 +-
> .../userspace-api/media/v4l/func-mmap.rst | 9 +-
> .../userspace-api/media/v4l/func-munmap.rst | 9 +-
> .../userspace-api/media/v4l/func-open.rst | 9 +-
> .../userspace-api/media/v4l/func-poll.rst | 9 +-
> .../userspace-api/media/v4l/func-read.rst | 9 +-
> .../userspace-api/media/v4l/func-select.rst | 9 +-
> .../userspace-api/media/v4l/func-write.rst | 9 +-
> .../userspace-api/media/v4l/hist-v4l2.rst | 9 +-
> .../userspace-api/media/v4l/hsv-formats.rst | 9 +-
> Documentation/userspace-api/media/v4l/io.rst | 9 +-
> .../media/v4l/libv4l-introduction.rst | 9 +-
> .../userspace-api/media/v4l/libv4l.rst | 9 +-
> .../userspace-api/media/v4l/meta-formats.rst | 9 +-
> .../userspace-api/media/v4l/mmap.rst | 9 +-
> .../userspace-api/media/v4l/open.rst | 9 +-
> .../userspace-api/media/v4l/pixfmt-bayer.rst | 9 +-
> .../media/v4l/pixfmt-compressed.rst | 9 +-
> .../userspace-api/media/v4l/pixfmt-grey.rst | 9 +-
> .../media/v4l/pixfmt-indexed.rst | 9 +-
> .../userspace-api/media/v4l/pixfmt-intro.rst | 9 +-
> .../userspace-api/media/v4l/pixfmt-inzi.rst | 9 +-
> .../userspace-api/media/v4l/pixfmt-m420.rst | 9 +-
> .../media/v4l/pixfmt-meta-d4xx.rst | 9 +-
> .../media/v4l/pixfmt-meta-intel-ipu3.rst | 25 +-
> .../media/v4l/pixfmt-meta-uvc.rst | 9 +-
> .../media/v4l/pixfmt-meta-vivid.rst | 26 +-
> .../media/v4l/pixfmt-meta-vsp1-hgo.rst | 9 +-
> .../media/v4l/pixfmt-meta-vsp1-hgt.rst | 9 +-
> .../userspace-api/media/v4l/pixfmt-nv12.rst | 9 +-
> .../userspace-api/media/v4l/pixfmt-nv12m.rst | 9 +-
> .../userspace-api/media/v4l/pixfmt-nv12mt.rst | 9 +-
> .../userspace-api/media/v4l/pixfmt-nv16.rst | 9 +-
> .../userspace-api/media/v4l/pixfmt-nv16m.rst | 9 +-
> .../userspace-api/media/v4l/pixfmt-nv24.rst | 9 +-
> .../media/v4l/pixfmt-packed-hsv.rst | 9 +-
> .../media/v4l/pixfmt-packed-yuv.rst | 9 +-
> .../media/v4l/pixfmt-reserved.rst | 9 +-
> .../userspace-api/media/v4l/pixfmt-rgb.rst | 9 +-
> .../media/v4l/pixfmt-sdr-cs08.rst | 9 +-
> .../media/v4l/pixfmt-sdr-cs14le.rst | 9 +-
> .../media/v4l/pixfmt-sdr-cu08.rst | 9 +-
> .../media/v4l/pixfmt-sdr-cu16le.rst | 9 +-
> .../media/v4l/pixfmt-sdr-pcu16be.rst | 9 +-
> .../media/v4l/pixfmt-sdr-pcu18be.rst | 9 +-
> .../media/v4l/pixfmt-sdr-pcu20be.rst | 9 +-
> .../media/v4l/pixfmt-sdr-ru12le.rst | 9 +-
> .../media/v4l/pixfmt-srggb10-ipu3.rst | 9 +-
> .../media/v4l/pixfmt-srggb10.rst | 9 +-
> .../media/v4l/pixfmt-srggb10alaw8.rst | 9 +-
> .../media/v4l/pixfmt-srggb10dpcm8.rst | 9 +-
> .../media/v4l/pixfmt-srggb10p.rst | 9 +-
> .../media/v4l/pixfmt-srggb12.rst | 9 +-
> .../media/v4l/pixfmt-srggb12p.rst | 9 +-
> .../media/v4l/pixfmt-srggb14.rst | 9 +-
> .../media/v4l/pixfmt-srggb14p.rst | 9 +-
> .../media/v4l/pixfmt-srggb16.rst | 9 +-
> .../userspace-api/media/v4l/pixfmt-srggb8.rst | 9 +-
> .../media/v4l/pixfmt-tch-td08.rst | 9 +-
> .../media/v4l/pixfmt-tch-td16.rst | 9 +-
> .../media/v4l/pixfmt-tch-tu08.rst | 9 +-
> .../media/v4l/pixfmt-tch-tu16.rst | 9 +-
> .../userspace-api/media/v4l/pixfmt-uv8.rst | 9 +-
> .../userspace-api/media/v4l/pixfmt-uyvy.rst | 9 +-
> .../media/v4l/pixfmt-v4l2-mplane.rst | 9 +-
> .../userspace-api/media/v4l/pixfmt-v4l2.rst | 9 +-
> .../userspace-api/media/v4l/pixfmt-vyuy.rst | 9 +-
> .../userspace-api/media/v4l/pixfmt-y10.rst | 9 +-
> .../userspace-api/media/v4l/pixfmt-y10b.rst | 9 +-
> .../userspace-api/media/v4l/pixfmt-y10p.rst | 9 +-
> .../userspace-api/media/v4l/pixfmt-y12.rst | 9 +-
> .../userspace-api/media/v4l/pixfmt-y12i.rst | 9 +-
> .../userspace-api/media/v4l/pixfmt-y14.rst | 9 +-
> .../userspace-api/media/v4l/pixfmt-y16-be.rst | 9 +-
> .../userspace-api/media/v4l/pixfmt-y16.rst | 9 +-
> .../userspace-api/media/v4l/pixfmt-y41p.rst | 9 +-
> .../userspace-api/media/v4l/pixfmt-y8i.rst | 9 +-
> .../userspace-api/media/v4l/pixfmt-yuv410.rst | 9 +-
> .../media/v4l/pixfmt-yuv411p.rst | 9 +-
> .../userspace-api/media/v4l/pixfmt-yuv420.rst | 9 +-
> .../media/v4l/pixfmt-yuv420m.rst | 9 +-
> .../media/v4l/pixfmt-yuv422m.rst | 9 +-
> .../media/v4l/pixfmt-yuv422p.rst | 9 +-
> .../media/v4l/pixfmt-yuv444m.rst | 9 +-
> .../userspace-api/media/v4l/pixfmt-yuyv.rst | 9 +-
> .../userspace-api/media/v4l/pixfmt-yvyu.rst | 9 +-
> .../userspace-api/media/v4l/pixfmt-z16.rst | 9 +-
> .../userspace-api/media/v4l/pixfmt.rst | 9 +-
> .../userspace-api/media/v4l/planar-apis.rst | 9 +-
> .../userspace-api/media/v4l/querycap.rst | 9 +-
> Documentation/userspace-api/media/v4l/rw.rst | 9 +-
> .../userspace-api/media/v4l/sdr-formats.rst | 9 +-
> .../media/v4l/selection-api-configuration.rst | 9 +-
> .../media/v4l/selection-api-examples.rst | 9 +-
> .../media/v4l/selection-api-intro.rst | 9 +-
> .../media/v4l/selection-api-targets.rst | 9 +-
> .../media/v4l/selection-api-vs-crop-api.rst | 9 +-
> .../userspace-api/media/v4l/selection-api.rst | 9 +-
> .../media/v4l/selections-common.rst | 9 +-
> .../userspace-api/media/v4l/standard.rst | 9 +-
> .../userspace-api/media/v4l/streaming-par.rst | 9 +-
> .../media/v4l/subdev-formats.rst | 9 +-
> .../userspace-api/media/v4l/tch-formats.rst | 9 +-
> .../userspace-api/media/v4l/tuner.rst | 9 +-
> .../userspace-api/media/v4l/user-func.rst | 9 +-
> .../userspace-api/media/v4l/userp.rst | 9 +-
> .../media/v4l/v4l2-selection-flags.rst | 9 +-
> .../media/v4l/v4l2-selection-targets.rst | 9 +-
> .../userspace-api/media/v4l/v4l2.rst | 9 +-
> .../media/v4l/v4l2grab-example.rst | 9 +-
> .../userspace-api/media/v4l/v4l2grab.c.rst | 9 +-
> .../userspace-api/media/v4l/video.rst | 9 +-
> .../userspace-api/media/v4l/videodev.rst | 9 +-
> .../media/v4l/vidioc-create-bufs.rst | 9 +-
> .../media/v4l/vidioc-cropcap.rst | 9 +-
> .../media/v4l/vidioc-dbg-g-chip-info.rst | 9 +-
> .../media/v4l/vidioc-dbg-g-register.rst | 9 +-
> .../media/v4l/vidioc-decoder-cmd.rst | 9 +-
> .../media/v4l/vidioc-dqevent.rst | 9 +-
> .../media/v4l/vidioc-dv-timings-cap.rst | 9 +-
> .../media/v4l/vidioc-encoder-cmd.rst | 9 +-
> .../media/v4l/vidioc-enum-dv-timings.rst | 9 +-
> .../media/v4l/vidioc-enum-fmt.rst | 9 +-
> .../media/v4l/vidioc-enum-frameintervals.rst | 9 +-
> .../media/v4l/vidioc-enum-framesizes.rst | 9 +-
> .../media/v4l/vidioc-enum-freq-bands.rst | 9 +-
> .../media/v4l/vidioc-enumaudio.rst | 9 +-
> .../media/v4l/vidioc-enumaudioout.rst | 9 +-
> .../media/v4l/vidioc-enuminput.rst | 9 +-
> .../media/v4l/vidioc-enumoutput.rst | 9 +-
> .../media/v4l/vidioc-enumstd.rst | 9 +-
> .../userspace-api/media/v4l/vidioc-expbuf.rst | 9 +-
> .../media/v4l/vidioc-g-audio.rst | 9 +-
> .../media/v4l/vidioc-g-audioout.rst | 9 +-
> .../userspace-api/media/v4l/vidioc-g-crop.rst | 9 +-
> .../userspace-api/media/v4l/vidioc-g-ctrl.rst | 9 +-
> .../media/v4l/vidioc-g-dv-timings.rst | 9 +-
> .../userspace-api/media/v4l/vidioc-g-edid.rst | 9 +-
> .../media/v4l/vidioc-g-enc-index.rst | 9 +-
> .../media/v4l/vidioc-g-ext-ctrls.rst | 9 +-
> .../userspace-api/media/v4l/vidioc-g-fbuf.rst | 9 +-
> .../userspace-api/media/v4l/vidioc-g-fmt.rst | 9 +-
> .../media/v4l/vidioc-g-frequency.rst | 9 +-
> .../media/v4l/vidioc-g-input.rst | 9 +-
> .../media/v4l/vidioc-g-jpegcomp.rst | 9 +-
> .../media/v4l/vidioc-g-modulator.rst | 9 +-
> .../media/v4l/vidioc-g-output.rst | 9 +-
> .../userspace-api/media/v4l/vidioc-g-parm.rst | 9 +-
> .../media/v4l/vidioc-g-priority.rst | 9 +-
> .../media/v4l/vidioc-g-selection.rst | 9 +-
> .../media/v4l/vidioc-g-sliced-vbi-cap.rst | 9 +-
> .../userspace-api/media/v4l/vidioc-g-std.rst | 9 +-
> .../media/v4l/vidioc-g-tuner.rst | 9 +-
> .../media/v4l/vidioc-log-status.rst | 9 +-
> .../media/v4l/vidioc-overlay.rst | 9 +-
> .../media/v4l/vidioc-prepare-buf.rst | 9 +-
> .../userspace-api/media/v4l/vidioc-qbuf.rst | 9 +-
> .../media/v4l/vidioc-query-dv-timings.rst | 9 +-
> .../media/v4l/vidioc-querybuf.rst | 9 +-
> .../media/v4l/vidioc-querycap.rst | 9 +-
> .../media/v4l/vidioc-queryctrl.rst | 9 +-
> .../media/v4l/vidioc-querystd.rst | 9 +-
> .../media/v4l/vidioc-reqbufs.rst | 9 +-
> .../media/v4l/vidioc-s-hw-freq-seek.rst | 9 +-
> .../media/v4l/vidioc-streamon.rst | 9 +-
> .../v4l/vidioc-subdev-enum-frame-interval.rst | 9 +-
> .../v4l/vidioc-subdev-enum-frame-size.rst | 9 +-
> .../v4l/vidioc-subdev-enum-mbus-code.rst | 9 +-
> .../media/v4l/vidioc-subdev-g-crop.rst | 9 +-
> .../media/v4l/vidioc-subdev-g-fmt.rst | 9 +-
> .../v4l/vidioc-subdev-g-frame-interval.rst | 9 +-
> .../media/v4l/vidioc-subdev-g-selection.rst | 9 +-
> .../media/v4l/vidioc-subdev-querycap.rst | 9 +-
> .../media/v4l/vidioc-subscribe-event.rst | 9 +-
> .../userspace-api/media/v4l/yuv-formats.rst | 9 +-
> LICENSES/deprecated/GFDL-1.1+ | 366 ++++++++
> LICENSES/deprecated/GFDL-1.2 | 408 +++++++++
> arch/Kconfig | 2 +-
> init/Kconfig | 2 +-
> mm/Kconfig | 2 +-
> mm/nommu.c | 2 +-
> 443 files changed, 1801 insertions(+), 4023 deletions(-)
> rename Documentation/{nommu-mmap.txt => admin-guide/mm/nommu-mmap.rst} (100%)
> rename Documentation/{bus-virt-phys-mapping.txt => core-api/bus-virt-phys-mapping.rst} (100%)
> rename Documentation/{this_cpu_ops.txt => core-api/this_cpu_ops.rst} (100%)
> rename Documentation/{process => core-api}/unaligned-memory-access.rst (100%)
> rename Documentation/devicetree/{booting-without-of.txt => booting-without-of.rst} (90%)
> rename Documentation/{mailbox.txt => driver-api/mailbox.rst} (100%)
> rename Documentation/trace/{ring-buffer-design.txt => ring-buffer-design.rst} (57%)
> create mode 100644 LICENSES/deprecated/GFDL-1.1+
> create mode 100644 LICENSES/deprecated/GFDL-1.2
>
> --
> 2.26.2
>
>
^ permalink raw reply [flat|nested] 15+ messages in thread
* Re: [PATCH v2 0/9] Convert the remaining text files to ReST and add SPDX for GFDL
2020-06-23 11:58 ` [PATCH v2 0/9] Convert the remaining text files to ReST and add SPDX for GFDL Kate Stewart
@ 2020-06-23 13:37 ` Mauro Carvalho Chehab
0 siblings, 0 replies; 15+ messages in thread
From: Mauro Carvalho Chehab @ 2020-06-23 13:37 UTC (permalink / raw)
To: Kate Stewart
Cc: Linux Doc Mailing List, LKML, Jonathan Corbet, Bingbu Cao,
Maxime Ripard, Yong Zhi, Thomas Gleixner, Tian Shu Qiu,
Rob Herring, devicetree, linux-spdx, linux-mm, linux-media,
dri-devel, Greg Kroah-Hartman, Andrew Morton, Sakari Ailus,
Harry Wei, David Airlie, Maarten Lankhorst, Daniel Vetter,
Thomas Zimmermann, Hans Verkuil, Alex Shi
Hi Kate,
Em Tue, 23 Jun 2020 06:58:55 -0500
Kate Stewart <kstewart@linuxfoundation.org> escreveu:
> On Tue, Jun 23, 2020 at 4:53 AM Mauro Carvalho Chehab
> <mchehab+huawei@kernel.org> wrote:
> >
> > The main goal of this series is to finish the ReST conversion. After this
> > series, we have just those files still in plain old format:
> >
> > - Documentation/RCU/RTFP.txt
> > - Documentation/atomic_bitops.txt
> > - Documentation/memory-barriers.txt
> > - Documentation/atomic_t.txt
> > - Documentation/filesystems/dax.txt
> > - Documentation/filesystems/path-lookup.txt
> > - Documentation/virt/kvm/devices/README
> >
> > PS.: I'm using a script to remove false-positives and ignore non-converted
> > translated files.
> >
> > It is worth to mention that this fseries contain licenses for the two
> > GFDL licenses used within the Kernel: GFDL-1.1+ and GFDL-1.2.
> >
> > Those licenses are the result of long discussions with the SPDX legal
> > team, and are part of this commit, to be added for the future
> > SPDX 3.10 version:
> > https://github.com/spdx/license-list-XML/pull/1048/commits/f695d2ac65230d0f4161ba58fff2f9d87bb5a053
> >
> > Mauro Carvalho Chehab (9):
> > docs: dt: convert booting-without-of.txt to ReST format
> > LICENSES: add GFDL licenses
> > media: docs: use SPDX GFDL-1.1-or-later-no-invariants
>
> The identifier "GFDL-1.1-or-later-no-invariants" isn't following expected
> construction (or-later and -only at the end) and the pull request is
> still under
> discussion on the SPDX license list, so please hold off on applying this
> until the correct identifier is figured out there.
Thanks for checking this. I assumed that the discussions on SPDX were
finished. For now, I'll keep using a license text at the Kernel
(on media and on another file dual-licensed GPL and GFDL).
I'm keeping the patches changing the license on a temp branch. I'll
re-submit them once the patch gets merged at SPDX specs tree.
Btw, another file using both GPL and GFDL was just added via the
media tree[1]. I need to remember that when re-submitting this one,
as otherwise it would be a left-over.
[1] Due to historic reasons, media userspace API is licensed under
GFDL. We're using a dual-license model for newer files at the
media uAPI book.
Thanks!
Mauro
^ permalink raw reply [flat|nested] 15+ messages in thread
* Re: [PATCH v2 5/9] docs: move nommu-mmap.txt to admin-guide and rename to ReST
2020-06-23 9:52 ` [PATCH v2 5/9] docs: move nommu-mmap.txt to admin-guide and rename to ReST Mauro Carvalho Chehab
@ 2020-06-23 15:56 ` Mike Rapoport
0 siblings, 0 replies; 15+ messages in thread
From: Mike Rapoport @ 2020-06-23 15:56 UTC (permalink / raw)
To: Mauro Carvalho Chehab
Cc: Linux Doc Mailing List, linux-kernel, Jonathan Corbet,
David Airlie, Daniel Vetter, Maarten Lankhorst, Maxime Ripard,
Thomas Zimmermann, Andrew Morton, dri-devel, linux-mm
On Tue, Jun 23, 2020 at 11:52:58AM +0200, Mauro Carvalho Chehab wrote:
> The nommu-mmap.txt file provides description of user visible
> behaviuour. So, move it to the admin-guide.
>
> As it is already at the ReST, also rename it.
>
> Suggested-by: Mike Rapoport <rppt@linux.ibm.com>
> Suggested-by: Jonathan Corbet <corbet@lwn.net>
> Signed-off-by: Mauro Carvalho Chehab <mchehab+huawei@kernel.org>
Acked-by: Mike Rapoport <rppt@linux.ibm.com>
> ---
> Documentation/admin-guide/mm/index.rst | 1 +
> Documentation/{nommu-mmap.txt => admin-guide/mm/nommu-mmap.rst} | 0
> Documentation/admin-guide/sysctl/vm.rst | 2 +-
> Documentation/gpu/drm-mm.rst | 2 +-
> init/Kconfig | 2 +-
> mm/Kconfig | 2 +-
> mm/nommu.c | 2 +-
> 7 files changed, 6 insertions(+), 5 deletions(-)
> rename Documentation/{nommu-mmap.txt => admin-guide/mm/nommu-mmap.rst} (100%)
>
> diff --git a/Documentation/admin-guide/mm/index.rst b/Documentation/admin-guide/mm/index.rst
> index 11db46448354..774dad6d3d29 100644
> --- a/Documentation/admin-guide/mm/index.rst
> +++ b/Documentation/admin-guide/mm/index.rst
> @@ -31,6 +31,7 @@ the Linux memory management.
> idle_page_tracking
> ksm
> memory-hotplug
> + nommu-map
> numa_memory_policy
> numaperf
> pagemap
> diff --git a/Documentation/nommu-mmap.txt b/Documentation/admin-guide/mm/nommu-mmap.rst
> similarity index 100%
> rename from Documentation/nommu-mmap.txt
> rename to Documentation/admin-guide/mm/nommu-mmap.rst
> diff --git a/Documentation/admin-guide/sysctl/vm.rst b/Documentation/admin-guide/sysctl/vm.rst
> index 4b7c496199ca..4b9d2e8e9142 100644
> --- a/Documentation/admin-guide/sysctl/vm.rst
> +++ b/Documentation/admin-guide/sysctl/vm.rst
> @@ -598,7 +598,7 @@ trimming of allocations is initiated.
>
> The default value is 1.
>
> -See Documentation/nommu-mmap.txt for more information.
> +See Documentation/admin-guide/mm/nommu-mmap.rst for more information.
>
>
> numa_zonelist_order
> diff --git a/Documentation/gpu/drm-mm.rst b/Documentation/gpu/drm-mm.rst
> index 8d10e6b38918..9abee1589c1e 100644
> --- a/Documentation/gpu/drm-mm.rst
> +++ b/Documentation/gpu/drm-mm.rst
> @@ -311,7 +311,7 @@ To use drm_gem_cma_get_unmapped_area(), drivers must fill the struct
> a pointer on drm_gem_cma_get_unmapped_area().
>
> More detailed information about get_unmapped_area can be found in
> -Documentation/nommu-mmap.txt
> +Documentation/admin-guide/mm/nommu-mmap.rst
>
> Memory Coherency
> ----------------
> diff --git a/init/Kconfig b/init/Kconfig
> index a46aa8f3174d..2dd5531dae98 100644
> --- a/init/Kconfig
> +++ b/init/Kconfig
> @@ -1957,7 +1957,7 @@ config MMAP_ALLOW_UNINITIALIZED
> userspace. Since that isn't generally a problem on no-MMU systems,
> it is normally safe to say Y here.
>
> - See Documentation/nommu-mmap.txt for more information.
> + See Documentation/mm/nommu-mmap.rst for more information.
>
> config SYSTEM_DATA_VERIFICATION
> def_bool n
> diff --git a/mm/Kconfig b/mm/Kconfig
> index f2104cc0d35c..d41f3fa7e923 100644
> --- a/mm/Kconfig
> +++ b/mm/Kconfig
> @@ -387,7 +387,7 @@ config NOMMU_INITIAL_TRIM_EXCESS
> This option specifies the initial value of this option. The default
> of 1 says that all excess pages should be trimmed.
>
> - See Documentation/nommu-mmap.txt for more information.
> + See Documentation/mm/nommu-mmap.rst for more information.
>
> config TRANSPARENT_HUGEPAGE
> bool "Transparent Hugepage Support"
> diff --git a/mm/nommu.c b/mm/nommu.c
> index f32a69095d50..314174817b04 100644
> --- a/mm/nommu.c
> +++ b/mm/nommu.c
> @@ -5,7 +5,7 @@
> * Replacement code for mm functions to support CPU's that don't
> * have any form of memory management unit (thus no virtual memory).
> *
> - * See Documentation/nommu-mmap.txt
> + * See Documentation/mm/nommu-mmap.rst
> *
> * Copyright (c) 2004-2008 David Howells <dhowells@redhat.com>
> * Copyright (c) 2000-2003 David McCullough <davidm@snapgear.com>
> --
> 2.26.2
>
--
Sincerely yours,
Mike.
^ permalink raw reply [flat|nested] 15+ messages in thread
* Re: [PATCH v2 9/9] docs: staging: use small font for literal includes
2020-06-23 9:53 ` [PATCH v2 9/9] docs: staging: use small font for literal includes Mauro Carvalho Chehab
@ 2020-06-23 23:12 ` Joe Perches
2020-06-24 5:29 ` Mauro Carvalho Chehab
0 siblings, 1 reply; 15+ messages in thread
From: Joe Perches @ 2020-06-23 23:12 UTC (permalink / raw)
To: Mauro Carvalho Chehab, Linux Doc Mailing List
Cc: linux-kernel, Jonathan Corbet
On Tue, 2020-06-23 at 11:53 +0200, Mauro Carvalho Chehab wrote:
> The normal font is too big to display 80 columns, causing extra
> breaks to be added at weird places.
>
> change to the footnotesize, as this would fit a little bit
> better.
[]
> diff --git a/Documentation/staging/index.rst b/Documentation/staging/index.rst
[]
> @@ -19,14 +19,41 @@ Unsorted Documentation
> Atomic Types
> ============
>
> -.. literalinclude:: ../atomic_t.txt
> +.. raw:: latex
> +
> + \footnotesize
> +
> +.. include:: ../atomic_t.txt
> + :literal:
> +
> +.. raw:: latex
> +
> + \normalsize
Is there something like push/pop for styles?
Maybe some variant of include:: with a style?
^ permalink raw reply [flat|nested] 15+ messages in thread
* Re: [PATCH v2 9/9] docs: staging: use small font for literal includes
2020-06-23 23:12 ` Joe Perches
@ 2020-06-24 5:29 ` Mauro Carvalho Chehab
0 siblings, 0 replies; 15+ messages in thread
From: Mauro Carvalho Chehab @ 2020-06-24 5:29 UTC (permalink / raw)
To: Joe Perches; +Cc: Linux Doc Mailing List, linux-kernel, Jonathan Corbet
Em Tue, 23 Jun 2020 16:12:04 -0700
Joe Perches <joe@perches.com> escreveu:
> On Tue, 2020-06-23 at 11:53 +0200, Mauro Carvalho Chehab wrote:
> > The normal font is too big to display 80 columns, causing extra
> > breaks to be added at weird places.
> >
> > change to the footnotesize, as this would fit a little bit
> > better.
> []
> > diff --git a/Documentation/staging/index.rst b/Documentation/staging/index.rst
> []
> > @@ -19,14 +19,41 @@ Unsorted Documentation
> > Atomic Types
> > ============
> >
> > -.. literalinclude:: ../atomic_t.txt
> > +.. raw:: latex
> > +
> > + \footnotesize
> > +
> > +.. include:: ../atomic_t.txt
> > + :literal:
> > +
> > +.. raw:: latex
> > +
> > + \normalsize
>
> Is there something like push/pop for styles?
> Maybe some variant of include:: with a style?
Well, one could use, instead:
.. css-class:: some_footnote_class
Which should then require a "some_footnote_class" css file defined for
html output and a set of macros to be added at the "latex_elements"
section of conf.py.
If properly defined, I guess it should be possible to avoid the need
of returning to the normal size after using it.
This is easily said than done.
One of the problems with using such macros is that the macro
should be prepared to work not only with plain text but also with
more complex structures like tables or graphics.
We do need to use tricks like changing the font size on media docs,
in order to display tables with long lines. We have several of them
there, with bit mappings.
I tried a few times to play with that for PDF. I ended needing to
revert all such attempts[1]. The main problem playing with those is that
You'll end needing to play with the already defined macros found on
sphinx.sty, which is shipped together with Sphinx. The macros there
changed a lot over the time. Making something that would work with
different versions is really hard.
[1] I used those when I ported media docs from DocBook, but had to
drop several macros because version 1.7 broke the ones I defined.
On that time, I spent several days writing the first version, and,
when they broke, I spent a long time figuring out what would be the
best.
At the end, using the "raw:: latex" like the above was the only
thing that worked reliable among different Sphinx versions.
Thanks,
Mauro
^ permalink raw reply [flat|nested] 15+ messages in thread
end of thread, other threads:[~2020-06-24 5:29 UTC | newest]
Thread overview: 15+ messages (download: mbox.gz follow: Atom feed
-- links below jump to the message on this page --
2020-06-23 9:52 [PATCH v2 0/9] Convert the remaining text files to ReST and add SPDX for GFDL Mauro Carvalho Chehab
2020-06-23 9:52 ` [PATCH v2 1/9] docs: dt: convert booting-without-of.txt to ReST format Mauro Carvalho Chehab
2020-06-23 9:52 ` [PATCH v2 2/9] LICENSES: add GFDL licenses Mauro Carvalho Chehab
2020-06-23 11:47 ` Kate Stewart
2020-06-23 9:52 ` [PATCH v2 4/9] docs: trace: ring-buffer-design.txt: convert to ReST format Mauro Carvalho Chehab
2020-06-23 9:52 ` [PATCH v2 5/9] docs: move nommu-mmap.txt to admin-guide and rename to ReST Mauro Carvalho Chehab
2020-06-23 15:56 ` Mike Rapoport
2020-06-23 9:52 ` [PATCH v2 6/9] docs: move mailbox.txt to driver-api and rename it Mauro Carvalho Chehab
2020-06-23 9:53 ` [PATCH v2 7/9] docs: move other kAPI documents to core-api Mauro Carvalho Chehab
2020-06-23 9:53 ` [PATCH v2 8/9] docs: Add remaining Documentation/*.txt at staging/index.rst Mauro Carvalho Chehab
2020-06-23 9:53 ` [PATCH v2 9/9] docs: staging: use small font for literal includes Mauro Carvalho Chehab
2020-06-23 23:12 ` Joe Perches
2020-06-24 5:29 ` Mauro Carvalho Chehab
2020-06-23 11:58 ` [PATCH v2 0/9] Convert the remaining text files to ReST and add SPDX for GFDL Kate Stewart
2020-06-23 13:37 ` Mauro Carvalho Chehab
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).