From: Moritz Fischer <mdf@kernel.org>
To: Mauro Carvalho Chehab <mchehab+huawei@kernel.org>
Cc: Linux Doc Mailing List <linux-doc@vger.kernel.org>,
Jonathan Corbet <corbet@lwn.net>, Moritz Fischer <mdf@kernel.org>,
Tom Rix <trix@redhat.com>,
linux-fpga@vger.kernel.org, linux-kernel@vger.kernel.org
Subject: Re: [PATCH 13/53] docs: driver-api: fpga: avoid using UTF-8 chars
Date: Mon, 10 May 2021 10:48:38 -0700 [thread overview]
Message-ID: <YJlx9vLCleEMg+Hg@epycbox.lan> (raw)
In-Reply-To: <10fced4bcc033f4683fae41db0c494c1d3503ccb.1620641727.git.mchehab+huawei@kernel.org>
On Mon, May 10, 2021 at 12:26:25PM +0200, Mauro Carvalho Chehab wrote:
> While UTF-8 characters can be used at the Linux documentation,
> the best is to use them only when ASCII doesn't offer a good replacement.
> So, replace the occurences of the following UTF-8 characters:
>
> - U+2014 ('—'): EM DASH
>
> Signed-off-by: Mauro Carvalho Chehab <mchehab+huawei@kernel.org>
> ---
> Documentation/driver-api/fpga/fpga-bridge.rst | 10 +++++-----
> Documentation/driver-api/fpga/fpga-mgr.rst | 12 +++++------
> .../driver-api/fpga/fpga-programming.rst | 8 ++++----
> Documentation/driver-api/fpga/fpga-region.rst | 20 +++++++++----------
> 4 files changed, 25 insertions(+), 25 deletions(-)
>
> diff --git a/Documentation/driver-api/fpga/fpga-bridge.rst b/Documentation/driver-api/fpga/fpga-bridge.rst
> index 198aadafd3e7..8d650b4e2ce6 100644
> --- a/Documentation/driver-api/fpga/fpga-bridge.rst
> +++ b/Documentation/driver-api/fpga/fpga-bridge.rst
> @@ -4,11 +4,11 @@ FPGA Bridge
> API to implement a new FPGA bridge
> ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
>
> -* struct fpga_bridge — The FPGA Bridge structure
> -* struct fpga_bridge_ops — Low level Bridge driver ops
> -* devm_fpga_bridge_create() — Allocate and init a bridge struct
> -* fpga_bridge_register() — Register a bridge
> -* fpga_bridge_unregister() — Unregister a bridge
> +* struct fpga_bridge - The FPGA Bridge structure
> +* struct fpga_bridge_ops - Low level Bridge driver ops
> +* devm_fpga_bridge_create() - Allocate and init a bridge struct
> +* fpga_bridge_register() - Register a bridge
> +* fpga_bridge_unregister() - Unregister a bridge
>
> .. kernel-doc:: include/linux/fpga/fpga-bridge.h
> :functions: fpga_bridge
> diff --git a/Documentation/driver-api/fpga/fpga-mgr.rst b/Documentation/driver-api/fpga/fpga-mgr.rst
> index 917ee22db429..4d926b452cb3 100644
> --- a/Documentation/driver-api/fpga/fpga-mgr.rst
> +++ b/Documentation/driver-api/fpga/fpga-mgr.rst
> @@ -101,12 +101,12 @@ in state.
> API for implementing a new FPGA Manager driver
> ----------------------------------------------
>
> -* ``fpga_mgr_states`` — Values for :c:expr:`fpga_manager->state`.
> -* struct fpga_manager — the FPGA manager struct
> -* struct fpga_manager_ops — Low level FPGA manager driver ops
> -* devm_fpga_mgr_create() — Allocate and init a manager struct
> -* fpga_mgr_register() — Register an FPGA manager
> -* fpga_mgr_unregister() — Unregister an FPGA manager
> +* ``fpga_mgr_states`` - Values for :c:expr:`fpga_manager->state`.
> +* struct fpga_manager - the FPGA manager struct
> +* struct fpga_manager_ops - Low level FPGA manager driver ops
> +* devm_fpga_mgr_create() - Allocate and init a manager struct
> +* fpga_mgr_register() - Register an FPGA manager
> +* fpga_mgr_unregister() - Unregister an FPGA manager
>
> .. kernel-doc:: include/linux/fpga/fpga-mgr.h
> :functions: fpga_mgr_states
> diff --git a/Documentation/driver-api/fpga/fpga-programming.rst b/Documentation/driver-api/fpga/fpga-programming.rst
> index 002392dab04f..fb4da4240e96 100644
> --- a/Documentation/driver-api/fpga/fpga-programming.rst
> +++ b/Documentation/driver-api/fpga/fpga-programming.rst
> @@ -84,10 +84,10 @@ will generate that list. Here's some sample code of what to do next::
> API for programming an FPGA
> ---------------------------
>
> -* fpga_region_program_fpga() — Program an FPGA
> -* fpga_image_info() — Specifies what FPGA image to program
> -* fpga_image_info_alloc() — Allocate an FPGA image info struct
> -* fpga_image_info_free() — Free an FPGA image info struct
> +* fpga_region_program_fpga() - Program an FPGA
> +* fpga_image_info() - Specifies what FPGA image to program
> +* fpga_image_info_alloc() - Allocate an FPGA image info struct
> +* fpga_image_info_free() - Free an FPGA image info struct
>
> .. kernel-doc:: drivers/fpga/fpga-region.c
> :functions: fpga_region_program_fpga
> diff --git a/Documentation/driver-api/fpga/fpga-region.rst b/Documentation/driver-api/fpga/fpga-region.rst
> index 363a8171ab0a..2636a27c11b2 100644
> --- a/Documentation/driver-api/fpga/fpga-region.rst
> +++ b/Documentation/driver-api/fpga/fpga-region.rst
> @@ -45,19 +45,19 @@ An example of usage can be seen in the probe function of [#f2]_.
> API to add a new FPGA region
> ----------------------------
>
> -* struct fpga_region — The FPGA region struct
> -* devm_fpga_region_create() — Allocate and init a region struct
> -* fpga_region_register() — Register an FPGA region
> -* fpga_region_unregister() — Unregister an FPGA region
> +* struct fpga_region - The FPGA region struct
> +* devm_fpga_region_create() - Allocate and init a region struct
> +* fpga_region_register() - Register an FPGA region
> +* fpga_region_unregister() - Unregister an FPGA region
>
> The FPGA region's probe function will need to get a reference to the FPGA
> Manager it will be using to do the programming. This usually would happen
> during the region's probe function.
>
> -* fpga_mgr_get() — Get a reference to an FPGA manager, raise ref count
> -* of_fpga_mgr_get() — Get a reference to an FPGA manager, raise ref count,
> +* fpga_mgr_get() - Get a reference to an FPGA manager, raise ref count
> +* of_fpga_mgr_get() - Get a reference to an FPGA manager, raise ref count,
> given a device node.
> -* fpga_mgr_put() — Put an FPGA manager
> +* fpga_mgr_put() - Put an FPGA manager
>
> The FPGA region will need to specify which bridges to control while programming
> the FPGA. The region driver can build a list of bridges during probe time
> @@ -66,11 +66,11 @@ the list of bridges to program just before programming
> (:c:expr:`fpga_region->get_bridges`). The FPGA bridge framework supplies the
> following APIs to handle building or tearing down that list.
>
> -* fpga_bridge_get_to_list() — Get a ref of an FPGA bridge, add it to a
> +* fpga_bridge_get_to_list() - Get a ref of an FPGA bridge, add it to a
> list
> -* of_fpga_bridge_get_to_list() — Get a ref of an FPGA bridge, add it to a
> +* of_fpga_bridge_get_to_list() - Get a ref of an FPGA bridge, add it to a
> list, given a device node
> -* fpga_bridges_put() — Given a list of bridges, put them
> +* fpga_bridges_put() - Given a list of bridges, put them
>
> .. kernel-doc:: include/linux/fpga/fpga-region.h
> :functions: fpga_region
> --
> 2.30.2
>
Applied to for-next,
Thanks
next prev parent reply other threads:[~2021-05-10 17:48 UTC|newest]
Thread overview: 92+ messages / expand[flat|nested] mbox.gz Atom feed top
2021-05-10 10:26 [PATCH 00/53] Get rid of UTF-8 chars that can be mapped as ASCII Mauro Carvalho Chehab
2021-05-10 10:26 ` [PATCH 01/53] docs: cdrom-standard.rst: get rid of uneeded UTF-8 chars Mauro Carvalho Chehab
2021-05-10 10:26 ` [PATCH 02/53] docs: ABI: remove a meaningless UTF-8 character Mauro Carvalho Chehab
2021-05-10 10:26 ` [PATCH 03/53] docs: ABI: remove some spurious characters Mauro Carvalho Chehab
2021-05-10 10:26 ` [PATCH 04/53] docs: index.rst: avoid using UTF-8 chars Mauro Carvalho Chehab
2021-05-10 10:26 ` [PATCH 05/53] docs: hwmon: " Mauro Carvalho Chehab
2021-05-10 13:30 ` Guenter Roeck
2021-05-10 10:26 ` [PATCH 06/53] docs: admin-guide: " Mauro Carvalho Chehab
2021-05-10 18:40 ` Gabriel Krisman Bertazi
2021-05-12 8:44 ` Mauro Carvalho Chehab
2021-05-12 9:25 ` David Woodhouse
2021-05-12 10:22 ` Mauro Carvalho Chehab
2021-05-10 10:26 ` [PATCH 07/53] docs: admin-guide: media: ipu3.rst: " Mauro Carvalho Chehab
2021-05-10 10:26 ` [PATCH 08/53] docs: admin-guide: sysctl: kernel.rst: " Mauro Carvalho Chehab
2021-05-10 10:26 ` [PATCH 09/53] docs: admin-guide: perf: imx-ddr.rst: " Mauro Carvalho Chehab
2021-05-10 10:26 ` [PATCH 10/53] docs: admin-guide: pm: " Mauro Carvalho Chehab
2021-05-10 10:26 ` [PATCH 11/53] docs: trace: coresight: coresight-etm4x-reference.rst: " Mauro Carvalho Chehab
2021-05-10 19:28 ` Mathieu Poirier
2021-05-10 10:26 ` [PATCH 12/53] docs: driver-api: " Mauro Carvalho Chehab
[not found] ` <CAHp75Vegsb-+fVppv3C7Jp0a=mEGAh2pchX=Cr5ZvOMFt+G73Q@mail.gmail.com>
2021-05-12 8:49 ` Mauro Carvalho Chehab
2021-05-10 10:26 ` [PATCH 13/53] docs: driver-api: fpga: " Mauro Carvalho Chehab
2021-05-10 17:48 ` Moritz Fischer [this message]
2021-05-10 10:26 ` [PATCH 14/53] docs: driver-api: iio: " Mauro Carvalho Chehab
2021-05-10 10:26 ` [PATCH 15/53] docs: driver-api: thermal: " Mauro Carvalho Chehab
2021-05-10 10:26 ` [PATCH 16/53] docs: driver-api: media: drivers: " Mauro Carvalho Chehab
2021-05-10 10:26 ` [PATCH 17/53] docs: driver-api: firmware: other_interfaces.rst: " Mauro Carvalho Chehab
2021-05-10 10:26 ` [PATCH 18/53] docs: driver-api: nvdimm: btt.rst: " Mauro Carvalho Chehab
2021-05-10 10:26 ` [PATCH 19/53] docs: fault-injection: nvme-fault-injection.rst: " Mauro Carvalho Chehab
2021-05-10 10:26 ` [PATCH 20/53] docs: usb: " Mauro Carvalho Chehab
2021-05-10 10:26 ` [PATCH 21/53] docs: process: " Mauro Carvalho Chehab
2021-05-10 10:26 ` [PATCH 22/53] docs: block: data-integrity.rst: " Mauro Carvalho Chehab
2021-05-10 10:26 ` [PATCH 23/53] docs: userspace-api: media: fdl-appendix.rst: " Mauro Carvalho Chehab
2021-05-10 10:26 ` [PATCH 24/53] docs: userspace-api: media: v4l: " Mauro Carvalho Chehab
2021-05-10 10:26 ` [PATCH 25/53] docs: userspace-api: media: dvb: " Mauro Carvalho Chehab
2021-05-10 10:26 ` [PATCH 26/53] docs: vm: zswap.rst: " Mauro Carvalho Chehab
2021-05-10 10:26 ` [PATCH 27/53] docs: filesystems: f2fs.rst: " Mauro Carvalho Chehab
2021-05-11 3:16 ` [f2fs-dev] " Chao Yu
2021-05-10 10:26 ` [PATCH 28/53] docs: filesystems: ext4: " Mauro Carvalho Chehab
2021-05-10 19:23 ` Theodore Ts'o
2021-05-10 10:26 ` [PATCH 29/53] docs: kernel-hacking: " Mauro Carvalho Chehab
2021-05-10 10:26 ` [PATCH 30/53] docs: hid: " Mauro Carvalho Chehab
2021-05-10 10:26 ` [PATCH 31/53] docs: security: tpm: " Mauro Carvalho Chehab
2021-05-10 10:26 ` [PATCH 32/53] docs: security: keys: trusted-encrypted.rst: " Mauro Carvalho Chehab
2021-05-10 10:26 ` [PATCH 33/53] docs: riscv: vm-layout.rst: " Mauro Carvalho Chehab
2021-05-10 10:26 ` [PATCH 34/53] docs: networking: scaling.rst: " Mauro Carvalho Chehab
2021-05-10 10:26 ` [PATCH 35/53] docs: networking: devlink: devlink-dpipe.rst: " Mauro Carvalho Chehab
2021-05-10 10:26 ` [PATCH 36/53] docs: networking: device_drivers: " Mauro Carvalho Chehab
2021-05-10 10:26 ` [PATCH 37/53] docs: x86: " Mauro Carvalho Chehab
2021-05-10 10:26 ` [PATCH 38/53] docs: scheduler: sched-deadline.rst: " Mauro Carvalho Chehab
2021-05-10 10:26 ` [PATCH 39/53] docs: dev-tools: testing-overview.rst: " Mauro Carvalho Chehab
2021-05-10 10:48 ` Marco Elver
2021-05-12 8:52 ` Mauro Carvalho Chehab
2021-05-10 23:35 ` David Gow
2021-05-12 8:14 ` Mauro Carvalho Chehab
2021-05-12 8:29 ` Mauro Carvalho Chehab
2021-05-10 10:26 ` [PATCH 40/53] docs: power: powercap: powercap.rst: " Mauro Carvalho Chehab
2021-05-10 10:26 ` [PATCH 41/53] docs: ABI: " Mauro Carvalho Chehab
2021-05-10 13:53 ` Guenter Roeck
2021-05-10 10:26 ` [PATCH 42/53] docs: doc-guide: contributing.rst: " Mauro Carvalho Chehab
2021-05-10 10:26 ` [PATCH 43/53] docs: PCI: acpi-info.rst: " Mauro Carvalho Chehab
2021-05-10 10:37 ` Krzysztof Wilczyński
2021-05-10 10:26 ` [PATCH 44/53] docs: gpu: " Mauro Carvalho Chehab
2021-05-10 11:16 ` Jani Nikula
2021-05-10 12:36 ` Liviu Dudau
2021-05-10 10:26 ` [PATCH 45/53] docs: sound: kernel-api: writing-an-alsa-driver.rst: " Mauro Carvalho Chehab
2021-05-10 10:26 ` [PATCH 46/53] docs: arm64: arm-acpi.rst: " Mauro Carvalho Chehab
2021-05-10 10:26 ` [PATCH 47/53] docs: infiniband: tag_matching.rst: " Mauro Carvalho Chehab
2021-05-10 10:27 ` [PATCH 48/53] docs: timers: no_hz.rst: " Mauro Carvalho Chehab
2021-05-10 10:27 ` [PATCH 49/53] docs: misc-devices: ibmvmc.rst: " Mauro Carvalho Chehab
2021-05-10 10:27 ` [PATCH 50/53] docs: firmware-guide: acpi: lpit.rst: " Mauro Carvalho Chehab
2021-05-10 10:27 ` [PATCH 51/53] docs: firmware-guide: acpi: dsd: graph.rst: " Mauro Carvalho Chehab
2021-05-10 10:27 ` [PATCH 52/53] docs: virt: kvm: " Mauro Carvalho Chehab
2021-05-10 10:27 ` [PATCH 53/53] docs: RCU: " Mauro Carvalho Chehab
2021-05-11 0:05 ` Paul E. McKenney
2021-05-10 10:52 ` [PATCH 00/53] Get rid of UTF-8 chars that can be mapped as ASCII Thorsten Leemhuis
2021-05-10 11:19 ` Mauro Carvalho Chehab
2021-05-10 12:27 ` Mauro Carvalho Chehab
2021-05-10 10:54 ` David Woodhouse
2021-05-10 11:55 ` Mauro Carvalho Chehab
2021-05-10 13:16 ` Edward Cree
2021-05-10 13:38 ` Mauro Carvalho Chehab
2021-05-10 13:58 ` Edward Cree
2021-05-10 13:59 ` Matthew Wilcox
2021-05-10 14:33 ` Edward Cree
2021-05-11 9:00 ` Mauro Carvalho Chehab
2021-05-11 9:19 ` David Woodhouse
2021-05-10 13:49 ` David Woodhouse
2021-05-10 19:22 ` Theodore Ts'o
2021-05-11 9:37 ` Mauro Carvalho Chehab
2021-05-11 9:25 ` Mauro Carvalho Chehab
2021-05-10 14:00 ` Ben Boeckel
2021-05-10 21:57 ` Adam Borowski
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=YJlx9vLCleEMg+Hg@epycbox.lan \
--to=mdf@kernel.org \
--cc=corbet@lwn.net \
--cc=linux-doc@vger.kernel.org \
--cc=linux-fpga@vger.kernel.org \
--cc=linux-kernel@vger.kernel.org \
--cc=mchehab+huawei@kernel.org \
--cc=trix@redhat.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).