mbox series

[libgpiod,v2,0/3] doc tweak corrections and renaming

Message ID 20220316020441.30001-1-warthog618@gmail.com
Headers show
Series doc tweak corrections and renaming | expand

Message

Kent Gibson March 16, 2022, 2:04 a.m. UTC
Another small series of patches following up on the two recent series.

The first patch is the corrections for patch 6 of the original series,
after omitting patches 2 and 4 and fixing conflicts and some other renaming.
This brings the conflicted sections into line with the rest of the docs.
There are also a few lines unrelated to the conflicts that differ between
my tree and yours.  Not sure if you have issues with them and dropped them,
or something else happened along the way.  I don't see anything terribly
contraversial so I've kept them in here.
And there is an unrelated indentation fix as well.

The second is using num_values more consistently.
These may actually be more corrections for doc tweaks, that slipped
through because they didn't conflict, and could be squashed into patch 1,
but kept them separate just in case.  And there is a corresponding code
rename as well, so it isn't purely documentation.

The final one is completing the renaming of "buf" variables to a name
more clearly indicating that they refer to uAPI types.
And renaming the conversion functions to match.

I think that is everything for the core for now.  Hopefully.

Cheers,
Kent.

Kent Gibson (3):
  doc: API documentation tweaks corrections
  core: use num_values rather than num_lines when dealing with subsets
    of values
  core: rename uAPI related variables and functions to uapi.

 include/gpiod.h      | 51 +++++++++++++++++++++++---------------------
 lib/chip-info.c      |  2 +-
 lib/chip.c           | 24 ++++++++++-----------
 lib/info-event.c     | 18 ++++++++--------
 lib/internal.h       | 20 ++++++++---------
 lib/line-config.c    | 24 ++++++++++-----------
 lib/line-info.c      |  2 +-
 lib/line-request.c   | 50 +++++++++++++++++++++----------------------
 lib/request-config.c | 12 +++++------
 9 files changed, 103 insertions(+), 100 deletions(-)


base-commit: 9d5112d0448fb2436e926a36842ff5ca365303c3

Comments

Bartosz Golaszewski March 17, 2022, 3:49 p.m. UTC | #1
On Wed, Mar 16, 2022 at 3:05 AM Kent Gibson <warthog618@gmail.com> wrote:
>
> The corrections to the doc tweaks patch 6, allowing for the omission
> of patches 2 and 4.
>
> Signed-off-by: Kent Gibson <warthog618@gmail.com>
> ---

Applied, thanks!

Bart
Bartosz Golaszewski March 17, 2022, 4:23 p.m. UTC | #2
On Wed, Mar 16, 2022 at 3:05 AM Kent Gibson <warthog618@gmail.com> wrote:
>
> Rename variables using the "buf" suffix to a "uapi_" prefix to identify
> them as being uAPI types.
> Similarly, rename the corresponding uAPI conversion functions from
> "kernel" to "uapi".
>
> Signed-off-by: Kent Gibson <warthog618@gmail.com>
> ---

Applied, thanks!

Bart