Linux kernel mirror (for testing) git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git
kernel os linux

cdrom: docs: reformat table in Documentation/userspace-api/ioctl/cdrom.rst

Add extra space to the first column of ioctl values table, and also realign
the text in the second column, to fix a documentation build warning
introduced by: commit 67f1e027c270 ("drivers/cdrom: improved ioctl for
media change detection")

Suggested-by: Randy Dunlap <rdunlap@infradead.org>
Fixes: 67f1e027c270 ("drivers/cdrom: improved ioctl for media change detection")
Signed-off-by: Phillip Potter <phil@philpotter.co.uk>
Reviewed-by: Randy Dunlap <rdunlap@infradead.org>
Link: https://lore.kernel.org/r/20211007231720.31997-1-phil@philpotter.co.uk
Signed-off-by: Jens Axboe <axboe@kernel.dk>

authored by

Phillip Potter and committed by
Jens Axboe
9c03fee7 67f1e027

+58 -58
+58 -58
Documentation/userspace-api/ioctl/cdrom.rst
··· 13 13 ioctl values are listed in <linux/cdrom.h>. As of this writing, they 14 14 are as follows: 15 15 16 - ====================== =============================================== 17 - CDROMPAUSE Pause Audio Operation 18 - CDROMRESUME Resume paused Audio Operation 19 - CDROMPLAYMSF Play Audio MSF (struct cdrom_msf) 20 - CDROMPLAYTRKIND Play Audio Track/index (struct cdrom_ti) 21 - CDROMREADTOCHDR Read TOC header (struct cdrom_tochdr) 22 - CDROMREADTOCENTRY Read TOC entry (struct cdrom_tocentry) 23 - CDROMSTOP Stop the cdrom drive 24 - CDROMSTART Start the cdrom drive 25 - CDROMEJECT Ejects the cdrom media 26 - CDROMVOLCTRL Control output volume (struct cdrom_volctrl) 27 - CDROMSUBCHNL Read subchannel data (struct cdrom_subchnl) 28 - CDROMREADMODE2 Read CDROM mode 2 data (2336 Bytes) 29 - (struct cdrom_read) 30 - CDROMREADMODE1 Read CDROM mode 1 data (2048 Bytes) 31 - (struct cdrom_read) 32 - CDROMREADAUDIO (struct cdrom_read_audio) 33 - CDROMEJECT_SW enable(1)/disable(0) auto-ejecting 34 - CDROMMULTISESSION Obtain the start-of-last-session 35 - address of multi session disks 36 - (struct cdrom_multisession) 37 - CDROM_GET_MCN Obtain the "Universal Product Code" 38 - if available (struct cdrom_mcn) 39 - CDROM_GET_UPC Deprecated, use CDROM_GET_MCN instead. 40 - CDROMRESET hard-reset the drive 41 - CDROMVOLREAD Get the drive's volume setting 42 - (struct cdrom_volctrl) 43 - CDROMREADRAW read data in raw mode (2352 Bytes) 44 - (struct cdrom_read) 45 - CDROMREADCOOKED read data in cooked mode 46 - CDROMSEEK seek msf address 47 - CDROMPLAYBLK scsi-cd only, (struct cdrom_blk) 48 - CDROMREADALL read all 2646 bytes 49 - CDROMGETSPINDOWN return 4-bit spindown value 50 - CDROMSETSPINDOWN set 4-bit spindown value 51 - CDROMCLOSETRAY pendant of CDROMEJECT 52 - CDROM_SET_OPTIONS Set behavior options 53 - CDROM_CLEAR_OPTIONS Clear behavior options 54 - CDROM_SELECT_SPEED Set the CD-ROM speed 55 - CDROM_SELECT_DISC Select disc (for juke-boxes) 56 - CDROM_MEDIA_CHANGED Check is media changed 57 - CDROM_TIMED_MEDIA_CHANGE Check if media changed 58 - since given time 59 - (struct cdrom_timed_media_change_info) 60 - CDROM_DRIVE_STATUS Get tray position, etc. 61 - CDROM_DISC_STATUS Get disc type, etc. 62 - CDROM_CHANGER_NSLOTS Get number of slots 63 - CDROM_LOCKDOOR lock or unlock door 64 - CDROM_DEBUG Turn debug messages on/off 65 - CDROM_GET_CAPABILITY get capabilities 66 - CDROMAUDIOBUFSIZ set the audio buffer size 67 - DVD_READ_STRUCT Read structure 68 - DVD_WRITE_STRUCT Write structure 69 - DVD_AUTH Authentication 70 - CDROM_SEND_PACKET send a packet to the drive 71 - CDROM_NEXT_WRITABLE get next writable block 72 - CDROM_LAST_WRITTEN get last block written on disc 73 - ====================== =============================================== 16 + ======================== =============================================== 17 + CDROMPAUSE Pause Audio Operation 18 + CDROMRESUME Resume paused Audio Operation 19 + CDROMPLAYMSF Play Audio MSF (struct cdrom_msf) 20 + CDROMPLAYTRKIND Play Audio Track/index (struct cdrom_ti) 21 + CDROMREADTOCHDR Read TOC header (struct cdrom_tochdr) 22 + CDROMREADTOCENTRY Read TOC entry (struct cdrom_tocentry) 23 + CDROMSTOP Stop the cdrom drive 24 + CDROMSTART Start the cdrom drive 25 + CDROMEJECT Ejects the cdrom media 26 + CDROMVOLCTRL Control output volume (struct cdrom_volctrl) 27 + CDROMSUBCHNL Read subchannel data (struct cdrom_subchnl) 28 + CDROMREADMODE2 Read CDROM mode 2 data (2336 Bytes) 29 + (struct cdrom_read) 30 + CDROMREADMODE1 Read CDROM mode 1 data (2048 Bytes) 31 + (struct cdrom_read) 32 + CDROMREADAUDIO (struct cdrom_read_audio) 33 + CDROMEJECT_SW enable(1)/disable(0) auto-ejecting 34 + CDROMMULTISESSION Obtain the start-of-last-session 35 + address of multi session disks 36 + (struct cdrom_multisession) 37 + CDROM_GET_MCN Obtain the "Universal Product Code" 38 + if available (struct cdrom_mcn) 39 + CDROM_GET_UPC Deprecated, use CDROM_GET_MCN instead. 40 + CDROMRESET hard-reset the drive 41 + CDROMVOLREAD Get the drive's volume setting 42 + (struct cdrom_volctrl) 43 + CDROMREADRAW read data in raw mode (2352 Bytes) 44 + (struct cdrom_read) 45 + CDROMREADCOOKED read data in cooked mode 46 + CDROMSEEK seek msf address 47 + CDROMPLAYBLK scsi-cd only, (struct cdrom_blk) 48 + CDROMREADALL read all 2646 bytes 49 + CDROMGETSPINDOWN return 4-bit spindown value 50 + CDROMSETSPINDOWN set 4-bit spindown value 51 + CDROMCLOSETRAY pendant of CDROMEJECT 52 + CDROM_SET_OPTIONS Set behavior options 53 + CDROM_CLEAR_OPTIONS Clear behavior options 54 + CDROM_SELECT_SPEED Set the CD-ROM speed 55 + CDROM_SELECT_DISC Select disc (for juke-boxes) 56 + CDROM_MEDIA_CHANGED Check is media changed 57 + CDROM_TIMED_MEDIA_CHANGE Check if media changed 58 + since given time 59 + (struct cdrom_timed_media_change_info) 60 + CDROM_DRIVE_STATUS Get tray position, etc. 61 + CDROM_DISC_STATUS Get disc type, etc. 62 + CDROM_CHANGER_NSLOTS Get number of slots 63 + CDROM_LOCKDOOR lock or unlock door 64 + CDROM_DEBUG Turn debug messages on/off 65 + CDROM_GET_CAPABILITY get capabilities 66 + CDROMAUDIOBUFSIZ set the audio buffer size 67 + DVD_READ_STRUCT Read structure 68 + DVD_WRITE_STRUCT Write structure 69 + DVD_AUTH Authentication 70 + CDROM_SEND_PACKET send a packet to the drive 71 + CDROM_NEXT_WRITABLE get next writable block 72 + CDROM_LAST_WRITTEN get last block written on disc 73 + ======================== =============================================== 74 74 75 75 76 76 The information that follows was determined from reading kernel source