linux-block.vger.kernel.org archive mirror
 help / color / mirror / Atom feed
From: Randy Dunlap <rdunlap@infradead.org>
To: Lukas Prediger <lumip@lumip.de>, phil@philpotter.co.uk
Cc: axboe@kernel.dk, hch@infradead.org, linux-block@vger.kernel.org,
	linux-kernel@vger.kernel.org
Subject: Re: [PATCH v3] drivers/cdrom: improved ioctl for media change detection
Date: Wed, 6 Oct 2021 13:52:44 -0700	[thread overview]
Message-ID: <42492b83-8741-786d-1b6e-cdd122576ae3@infradead.org> (raw)
In-Reply-To: <20210912191207.74449-1-lumip@lumip.de>

On 9/12/21 12:12 PM, Lukas Prediger wrote:
> diff --git a/Documentation/userspace-api/ioctl/cdrom.rst b/Documentation/userspace-api/ioctl/cdrom.rst
> index 3b4c0506de46..bac5bbf93ca0 100644
> --- a/Documentation/userspace-api/ioctl/cdrom.rst
> +++ b/Documentation/userspace-api/ioctl/cdrom.rst
> @@ -54,6 +54,9 @@ are as follows:
>   	CDROM_SELECT_SPEED	Set the CD-ROM speed
>   	CDROM_SELECT_DISC	Select disc (for juke-boxes)
>   	CDROM_MEDIA_CHANGED	Check is media changed
> +	CDROM_TIMED_MEDIA_CHANGE	Check if media changed
> +					since given time
> +					(struct cdrom_timed_media_change_info)
>   	CDROM_DRIVE_STATUS	Get tray position, etc.
>   	CDROM_DISC_STATUS	Get disc type, etc.
>   	CDROM_CHANGER_NSLOTS	Get number of slots

Hi Lukas, Phil,

This doc change causes a documentation build warning:

Documentation/userspace-api/ioctl/cdrom.rst:57: WARNING: Malformed table.
Text in column margin in table line 42.

The "=====" lines describe the table columns and they cannot be
exceeded without a warning. The table needs to be reformatted.

Lukas, will you handle that?
thanks.


======================  ===============================================
CDROMPAUSE              Pause Audio Operation
CDROMRESUME             Resume paused Audio Operation
CDROMPLAYMSF            Play Audio MSF (struct cdrom_msf)
CDROMPLAYTRKIND         Play Audio Track/index (struct cdrom_ti)
CDROMREADTOCHDR         Read TOC header (struct cdrom_tochdr)
CDROMREADTOCENTRY       Read TOC entry (struct cdrom_tocentry)
CDROMSTOP               Stop the cdrom drive
CDROMSTART              Start the cdrom drive
CDROMEJECT              Ejects the cdrom media
CDROMVOLCTRL            Control output volume (struct cdrom_volctrl)
CDROMSUBCHNL            Read subchannel data (struct cdrom_subchnl)
CDROMREADMODE2          Read CDROM mode 2 data (2336 Bytes)
                         (struct cdrom_read)
CDROMREADMODE1          Read CDROM mode 1 data (2048 Bytes)
                         (struct cdrom_read)
CDROMREADAUDIO          (struct cdrom_read_audio)
CDROMEJECT_SW           enable(1)/disable(0) auto-ejecting
CDROMMULTISESSION       Obtain the start-of-last-session
                         address of multi session disks
                         (struct cdrom_multisession)
CDROM_GET_MCN           Obtain the "Universal Product Code"
                         if available (struct cdrom_mcn)
CDROM_GET_UPC           Deprecated, use CDROM_GET_MCN instead.
CDROMRESET              hard-reset the drive
CDROMVOLREAD            Get the drive's volume setting
                         (struct cdrom_volctrl)
CDROMREADRAW            read data in raw mode (2352 Bytes)
                         (struct cdrom_read)
CDROMREADCOOKED         read data in cooked mode
CDROMSEEK               seek msf address
CDROMPLAYBLK            scsi-cd only, (struct cdrom_blk)
CDROMREADALL            read all 2646 bytes
CDROMGETSPINDOWN        return 4-bit spindown value
CDROMSETSPINDOWN        set 4-bit spindown value
CDROMCLOSETRAY          pendant of CDROMEJECT
CDROM_SET_OPTIONS       Set behavior options
CDROM_CLEAR_OPTIONS     Clear behavior options
CDROM_SELECT_SPEED      Set the CD-ROM speed
CDROM_SELECT_DISC       Select disc (for juke-boxes)
CDROM_MEDIA_CHANGED     Check is media changed
CDROM_TIMED_MEDIA_CHANGE        Check if media changed
                                 since given time
                                 (struct cdrom_timed_media_change_info)
CDROM_DRIVE_STATUS      Get tray position, etc.
CDROM_DISC_STATUS       Get disc type, etc.
CDROM_CHANGER_NSLOTS    Get number of slots
CDROM_LOCKDOOR          lock or unlock door
CDROM_DEBUG             Turn debug messages on/off
CDROM_GET_CAPABILITY    get capabilities
CDROMAUDIOBUFSIZ        set the audio buffer size
DVD_READ_STRUCT         Read structure
DVD_WRITE_STRUCT        Write structure
DVD_AUTH                Authentication
CDROM_SEND_PACKET       send a packet to the drive
CDROM_NEXT_WRITABLE     get next writable block
CDROM_LAST_WRITTEN      get last block written on disc
======================  ===============================================


-- 
~Randy

  parent reply	other threads:[~2021-10-06 20:52 UTC|newest]

Thread overview: 12+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2021-09-10 21:16 [PATCH v3] drivers/cdrom: improved ioctl for media change detection Lukas Prediger
2021-09-10 21:41 ` Randy Dunlap
2021-09-11 11:00   ` Phillip Potter
2021-09-11 17:48     ` Lukas Prediger
2021-09-12 18:04       ` Phillip Potter
2021-09-12 19:12         ` Lukas Prediger
2021-09-13  7:50           ` Phillip Potter
2021-10-06 20:52           ` Randy Dunlap [this message]
2021-10-07 23:04             ` Phillip Potter
2021-09-13 23:09 Phillip Potter
2021-09-15  2:05 ` Jens Axboe
2021-09-16 23:07   ` Phillip Potter

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=42492b83-8741-786d-1b6e-cdd122576ae3@infradead.org \
    --to=rdunlap@infradead.org \
    --cc=axboe@kernel.dk \
    --cc=hch@infradead.org \
    --cc=linux-block@vger.kernel.org \
    --cc=linux-kernel@vger.kernel.org \
    --cc=lumip@lumip.de \
    --cc=phil@philpotter.co.uk \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body. 
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).