You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@nuttx.apache.org by ac...@apache.org on 2023/10/27 16:21:55 UTC
(nuttx) 09/10: Documentation: fix ugly formating around some inline literals
This is an automated email from the ASF dual-hosted git repository.
acassis pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/nuttx.git
commit 579a35dc68c6c839f03fe09081a777d7f60ca719
Author: raiden00pl <ra...@railab.me>
AuthorDate: Fri Oct 27 17:22:27 2023 +0200
Documentation: fix ugly formating around some inline literals
---
Documentation/components/drivers/character/analog.rst | 6 +++---
Documentation/components/drivers/character/can.rst | 6 +++---
Documentation/components/drivers/character/leds/ws2812.rst | 6 +++---
Documentation/components/drivers/character/quadrature.rst | 6 +++---
Documentation/components/drivers/character/timers/pwm.rst | 6 +++---
Documentation/components/drivers/character/timers/rtc.rst | 6 +++---
Documentation/components/drivers/character/timers/timer.rst | 6 +++---
Documentation/components/drivers/character/timers/watchdog.rst | 6 +++---
Documentation/components/drivers/character/touchscreen.rst | 4 ++--
9 files changed, 26 insertions(+), 26 deletions(-)
diff --git a/Documentation/components/drivers/character/analog.rst b/Documentation/components/drivers/character/analog.rst
index f4714d8442..bbdad04e70 100644
--- a/Documentation/components/drivers/character/analog.rst
+++ b/Documentation/components/drivers/character/analog.rst
@@ -16,9 +16,9 @@ The NuttX analog drivers are split into two parts:
- Common analog logic and share-able analog drivers reside in the
``drivers/analog/``.
- Platform-specific drivers reside in
- ``arch/``\ *<architecture>*\ ``/src/``\ *<hardware>* directory
- for the specific processor *<architecture>* and for the
- specific *<chip>* analog peripheral devices.
+ ``arch/<architecture>//src/<hardware>`` directory
+ for the specific processor ``<architecture>`` and for the
+ specific ``<chip>`` analog peripheral devices.
ADC Drivers
-----------
diff --git a/Documentation/components/drivers/character/can.rst b/Documentation/components/drivers/character/can.rst
index b08ebb0e1a..68d95686a1 100644
--- a/Documentation/components/drivers/character/can.rst
+++ b/Documentation/components/drivers/character/can.rst
@@ -23,9 +23,9 @@ Files supporting CAN can be found in the following locations:
- **"Upper Half" Driver**. The generic, "upper half" CAN driver
resides at ``drivers/can.c``.
- **"Lower Half" Drivers**. Platform-specific CAN drivers reside
- in ``arch/``\ *<architecture>*\ ``/src/``\ *<hardware>*
- directory for the specific processor *<architecture>* and for
- the specific *<chip>* CAN peripheral devices.
+ in ``arch/<architecture>/src/<hardware>``
+ directory for the specific processor ``<architecture>`` and for
+ the specific ``<chip>`` CAN peripheral devices.
**Usage Note**: When reading from the CAN driver multiple messages
may be returned, depending on (1) the size the returned can
diff --git a/Documentation/components/drivers/character/leds/ws2812.rst b/Documentation/components/drivers/character/leds/ws2812.rst
index c173a8c4ae..4f9f8a4486 100644
--- a/Documentation/components/drivers/character/leds/ws2812.rst
+++ b/Documentation/components/drivers/character/leds/ws2812.rst
@@ -27,6 +27,6 @@ Files supporting ws2812 can be found in the following locations:
- **"Upper Half" Driver**. The generic, "upper half" ws2812 driver
resides at ``drivers/leds/ws2812.c``.
- **"Lower Half" Drivers**. Platform-specific ws2812 drivers reside
- in ``arch/``\ *<architecture>*\ ``/src/``\ *<hardware>*
- directory for the specific processor *<architecture>* and for
- the specific *<chip>* ws2812 peripheral devices.
+ in ``arch/<architecture>/src/<hardware>``
+ directory for the specific processor ``<architecture>`` and for
+ the specific ``<chip>`` ws2812 peripheral devices.
diff --git a/Documentation/components/drivers/character/quadrature.rst b/Documentation/components/drivers/character/quadrature.rst
index 6cf17c7a19..cd8013217b 100644
--- a/Documentation/components/drivers/character/quadrature.rst
+++ b/Documentation/components/drivers/character/quadrature.rst
@@ -24,7 +24,7 @@ following locations:
Encoder driver resides at ``drivers/sensors/qencoder.c``.
- **"Lower Half" Drivers**. Platform-specific Quadrature Encoder
drivers reside in
- ``arch/``\ *<architecture>*\ ``/src/``\ *<hardware>* directory
- for the specific processor *<architecture>* and for the
- specific *<chip>* Quadrature Encoder peripheral devices.
+ ``arch/<architecture>/src/<hardware>`` directory
+ for the specific processor ``<architecture>`` and for the
+ specific ``<chip>`` Quadrature Encoder peripheral devices.
diff --git a/Documentation/components/drivers/character/timers/pwm.rst b/Documentation/components/drivers/character/timers/pwm.rst
index 62226378a3..5d584afdea 100644
--- a/Documentation/components/drivers/character/timers/pwm.rst
+++ b/Documentation/components/drivers/character/timers/pwm.rst
@@ -29,6 +29,6 @@ Files supporting PWM can be found in the following locations:
- **"Upper Half" Driver**. The generic, "upper half" PWM driver
resides at ``drivers/timers/pwm.c``.
- **"Lower Half" Drivers**. Platform-specific PWM drivers reside
- in ``arch/``\ *<architecture>*\ ``/src/``\ *<hardware>*
- directory for the specific processor *<architecture>* and for
- the specific *<chip>* PWM peripheral devices.
+ in ``arch/<architecture>/src/<hardware>``
+ directory for the specific processor ``<architecture>`` and for
+ the specific ``<chip>`` PWM peripheral devices.
diff --git a/Documentation/components/drivers/character/timers/rtc.rst b/Documentation/components/drivers/character/timers/rtc.rst
index 59552c2293..184cada193 100644
--- a/Documentation/components/drivers/character/timers/rtc.rst
+++ b/Documentation/components/drivers/character/timers/rtc.rst
@@ -21,6 +21,6 @@ locations:
- **"Upper Half" Driver**. The generic, "upper half" RTC driver
resides at ``drivers/timers/rtc.c``.
- **"Lower Half" Drivers**. Platform-specific RTC drivers reside
- in ``arch/``\ *<architecture>*\ ``/src/``\ *<hardware>*
- directory for the specific processor *<architecture>* and for
- the specific *<chip>* RTC peripheral devices.
+ in ``arch/<architecture>/src/<hardware>``
+ directory for the specific processor ``<architecture>`` and for
+ the specific ``<chip>`` RTC peripheral devices.
diff --git a/Documentation/components/drivers/character/timers/timer.rst b/Documentation/components/drivers/character/timers/timer.rst
index cf15655a58..659316255a 100644
--- a/Documentation/components/drivers/character/timers/timer.rst
+++ b/Documentation/components/drivers/character/timers/timer.rst
@@ -13,9 +13,9 @@ locations:
- **"Upper Half" Driver**. The generic, "upper half" timer driver
resides at ``drivers/timers/timer.c``.
- **"Lower Half" Drivers**. Platform-specific timer drivers
- reside in ``arch/``\ *<architecture>*\ ``/src/``\ *<hardware>*
- directory for the specific processor *<architecture>* and for
- the specific *<chip>* timer peripheral devices.
+ reside in ``arch/<architecture>/src/<hardware>``
+ directory for the specific processor ``<architecture>`` and for
+ the specific ``<chip>`` timer peripheral devices.
There are two ways to enable Timer Support along with the Timer Example. The
first is faster and simpler. Just run the following command to use a ready
diff --git a/Documentation/components/drivers/character/timers/watchdog.rst b/Documentation/components/drivers/character/timers/watchdog.rst
index 47580d4766..94b689811d 100644
--- a/Documentation/components/drivers/character/timers/watchdog.rst
+++ b/Documentation/components/drivers/character/timers/watchdog.rst
@@ -24,9 +24,9 @@ following locations:
timer driver resides at ``drivers/timers/watchdog.c``.
- **"Lower Half" Drivers**. Platform-specific watchdog timer
drivers reside in
- ``arch/``\ *<architecture>*\ ``/src/``\ *<hardware>* directory
- for the specific processor *<architecture>* and for the
- specific *<chip>* watchdog timer peripheral devices.
+ ``arch/<architecture>//src/<hardware>`` directory
+ for the specific processor ``<architecture>`` and for the
+ specific ``<chip>`` watchdog timer peripheral devices.
There are two ways to enable Watchdog Timer Support along with the Watchdog Example.
The first is faster and simpler. Just run the following command to use a ready config
diff --git a/Documentation/components/drivers/character/touchscreen.rst b/Documentation/components/drivers/character/touchscreen.rst
index 70876d5ab1..00448e30af 100644
--- a/Documentation/components/drivers/character/touchscreen.rst
+++ b/Documentation/components/drivers/character/touchscreen.rst
@@ -30,9 +30,9 @@ found in the following locations:
touchscreen drivers reside in the directory ``drivers/input``.
- **"Lower Half" Drivers**. Platform-specific touchscreen drivers
reside in either: (1) The
- ``arch/``\ *<architecture>*\ ``/src/``\ *<hardware>* directory
+ ``arch/<architecture>/src/<hardware>`` directory
for the processor architectures that have build in touchscreen
controllers or (2) the
- ``boards/``\ *<arch>*\ ``/``\ *<chip>*\ ``/``\ *<board>*\ ``/src/``
+ ``boards/<arch>/<chip>/<board>/src/``
directory for boards that use an external touchscreen
controller chip.