linux-i2c.vger.kernel.org archive mirror
 help / color / mirror / Atom feed
From: Wolfram Sang <wsa@the-dreams.de>
To: Sam Hansen <hansens@google.com>
Cc: linux-i2c@vger.kernel.org, corbet@lwn.net,
	linux-doc@vger.kernel.org, linux-kernel@vger.kernel.org
Subject: Re: [PATCH v2 3/3] Documentation/i2c: adopt kernel commenting style in examples
Date: Fri, 13 Apr 2018 18:50:00 +0200	[thread overview]
Message-ID: <20180413165000.2svg2j5ozdd2egbd@ninjato> (raw)
In-Reply-To: <20180413164405.127522-3-hansens@google.com>

[-- Attachment #1: Type: text/plain, Size: 428 bytes --]


> -  int adapter_nr = 2; /* probably dynamically determined */

Such comments are actually OK.

> -    /* ERROR HANDLING; you can check errno to see what went wrong */

Such as well.

> -  /* Using I2C Write, equivalent of
> -     i2c_smbus_write_word_data(file, reg, 0x6543) */
> +  /*
> +   * Using I2C Write, equivalent of
> +   * i2c_smbus_write_word_data(file, reg, 0x6543).
> +   */

This is the only broken one AFAICT.


[-- Attachment #2: signature.asc --]
[-- Type: application/pgp-signature, Size: 833 bytes --]

  reply	other threads:[~2018-04-13 16:50 UTC|newest]

Thread overview: 15+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2018-04-12 21:33 [PATCH] Documentation/i2c: sync docs with current state of i2c-tools Sam Hansen
2018-04-12 22:24 ` Wolfram Sang
2018-04-13 12:13   ` Jean Delvare
2018-04-13 16:02     ` Sam Hansen
2018-04-13 16:44       ` [PATCH v2 1/3] Documentation/i2c: whitespace cleanup Sam Hansen
2018-04-13 16:44         ` [PATCH v2 2/3] Documentation/i2c: sync docs with current state of i2c-tools Sam Hansen
2018-04-13 16:50           ` Wolfram Sang
2018-04-13 16:44         ` [PATCH v2 3/3] Documentation/i2c: adopt kernel commenting style in examples Sam Hansen
2018-04-13 16:50           ` Wolfram Sang [this message]
2018-04-13 17:39             ` Sam Hansen
2018-04-13 16:50         ` [PATCH v2 1/3] Documentation/i2c: whitespace cleanup Wolfram Sang
2018-04-13 18:49       ` [PATCH] Documentation/i2c: sync docs with current state of i2c-tools Jean Delvare
2018-04-13 23:32         ` Sam Hansen
2018-04-14  6:27           ` Wolfram Sang
2018-04-17 19:17             ` Sam Hansen

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=20180413165000.2svg2j5ozdd2egbd@ninjato \
    --to=wsa@the-dreams.de \
    --cc=corbet@lwn.net \
    --cc=hansens@google.com \
    --cc=linux-doc@vger.kernel.org \
    --cc=linux-i2c@vger.kernel.org \
    --cc=linux-kernel@vger.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;
as well as URLs for NNTP newsgroup(s).