linux-doc.vger.kernel.org archive mirror
 help / color / mirror / Atom feed
From: Randy Dunlap <rdunlap@infradead.org>
To: Adrian Larumbe <adrian.larumbe@collabora.com>,
	Sebastian Fricke <sebastian.fricke@collabora.com>
Cc: Jonathan Corbet <corbet@lwn.net>,
	linux-doc@vger.kernel.org, linux-kernel@vger.kernel.org,
	linux-media@vger.kernel.org, laurent.pinchart@ideasonboard.com,
	hverkuil-cisco@xs4all.nl, mauro.chehab@linux.intel.com,
	kernel@collabora.com
Subject: Re: [PATCH RFC 2/2] docs: media: Debugging guide for the media subsystem
Date: Fri, 28 Jun 2024 12:34:58 -0700	[thread overview]
Message-ID: <d0d03b08-e21f-4e8a-9a2c-98b9176c9576@infradead.org> (raw)
In-Reply-To: <l5kou3gto442yl4uchmmahbpw53yfmluqyub4oxtlwinxsw3pn@njqimzbp2zmq>

Hi,

On 6/28/24 12:08 PM, Adrian Larumbe wrote:
> On 29.05.2024 18:22, Sebastian Fricke wrote:
>> Create a guides section for all documentation material, that isn't
>> strictly related to a specific piece of code.
>>
>> Provide a guide for developers on how to debug code with a focus on the
>> media subsystem. This document aims to provide a rough overview over the
>> possibilities and a rational to help choosing the right tool for the
>> given circumstances.
> Just like you, I'm not an English native speaker myself, so sometimes I make
> style mistakes that only seem obvious to someone whose native tongue is English.
> 
> What I do in the case of documentation patches is running the whole thing
> through languagetool (https://www.languagetool.org). It's LGPL and I suppose
> some vim versions might have a plugin that lets you interface with it from
> within the buffer you're editing. On my side, when running it on the previous
> paragraph, it showed the following warning:
> 
> [ADVISE_VBG[3] premium: false] The verb ‘help’ is used with an infinitive. -> (to choose, choose)

Ack that one. Also in that same sentence, s/rational/rationale/.

-- 
~Randy

      reply	other threads:[~2024-06-28 19:35 UTC|newest]

Thread overview: 7+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2024-05-29 16:22 [PATCH RFC 0/2] Documentation: Debugging guide Sebastian Fricke
2024-05-29 16:22 ` [PATCH RFC 1/2] docs: media: Create separate documentation folder for media Sebastian Fricke
2024-05-29 16:22 ` [PATCH RFC 2/2] docs: media: Debugging guide for the media subsystem Sebastian Fricke
2024-06-24 11:23   ` Hans Verkuil
2024-06-28 22:15     ` Laurent Pinchart
2024-06-28 19:08   ` Adrian Larumbe
2024-06-28 19:34     ` Randy Dunlap [this message]

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=d0d03b08-e21f-4e8a-9a2c-98b9176c9576@infradead.org \
    --to=rdunlap@infradead.org \
    --cc=adrian.larumbe@collabora.com \
    --cc=corbet@lwn.net \
    --cc=hverkuil-cisco@xs4all.nl \
    --cc=kernel@collabora.com \
    --cc=laurent.pinchart@ideasonboard.com \
    --cc=linux-doc@vger.kernel.org \
    --cc=linux-kernel@vger.kernel.org \
    --cc=linux-media@vger.kernel.org \
    --cc=mauro.chehab@linux.intel.com \
    --cc=sebastian.fricke@collabora.com \
    /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).