public inbox for linux-doc@vger.kernel.org
 help / color / mirror / Atom feed
From: Randy Dunlap <rdunlap@infradead.org>
To: Julia Lawall <julia.lawall@inria.fr>,
	mchehab+huawei@kernel.org, corbet@lwn.net
Cc: linux-doc@vger.kernel.org
Subject: Re: Documentation/scsi/aha152x.rst
Date: Wed, 29 Jul 2020 10:33:10 -0700	[thread overview]
Message-ID: <da610848-322c-3bcf-e351-bead548d8961@infradead.org> (raw)
In-Reply-To: <alpine.DEB.2.22.394.2007291908280.2459@hadrien>

On 7/29/20 10:16 AM, Julia Lawall wrote:
> Hello,
> 
> The ada152 documentation mentions some compilation flags.  This was
> converted to ReST as eg:
> 
> +- DAUTOCONF
> +    use configuration the controller reports (AHA-152x only)
> 
> --DAUTOCONF
> - use configuration the controller reports (AHA-152x only)
> 
> This is clearly not correct.  The - should be attached to the D, and not
> be converted to a bullet.  I tried replacing:
> 
> - DAUTOCONF
> 
> by
> 
> - -DAUTOCONF
> 
> but the result with rst2html was not very satisfactory.  The DAUTOCONF
> seems to be slightly raised with respect to the rest of the text.  And a
> subsequent case:
> 
> - DSETUP0="{ IOPORT, IRQ, SCSI_ID, RECONNECT, PARITY, SYNCHRONOUS, DELAY, EXT_TRANS }"
> 
> comes out different from the ones that have no associated list of possible
> values (larger letters, different font).
> 
> What should be done instead?
> 
> Also, does the kernel include some scripts for testing the documentation?
> make Documentation/scsi/aha152x.html doesn't seem to work.

I would do this:

$ make SPHINXDIRS="scsi" htmldocs

to limit the htmldocs build to Documentation/scsi/.
I don't know of a way to build only one output file.


-- 
~Randy


  reply	other threads:[~2020-07-29 17:33 UTC|newest]

Thread overview: 3+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2020-07-29 17:16 Documentation/scsi/aha152x.rst Julia Lawall
2020-07-29 17:33 ` Randy Dunlap [this message]
2020-07-29 18:06   ` Documentation/scsi/aha152x.rst Julia Lawall

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=da610848-322c-3bcf-e351-bead548d8961@infradead.org \
    --to=rdunlap@infradead.org \
    --cc=corbet@lwn.net \
    --cc=julia.lawall@inria.fr \
    --cc=linux-doc@vger.kernel.org \
    --cc=mchehab+huawei@kernel.org \
    /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