Skip to content

Commit 870f458

Browse files
lrgirdwolgirdwood
authored andcommitted
doc: fix woke terminology and resolve pygments lexer warning
- Sanitize non-inclusive terms in developer guides, diagrams, and testbench documentation. - Replace c code-block with text in rimage toml.h excerpt to resolve Pygments token failure. Signed-off-by: Liam Girdwood <liam.r.girdwood@linux.intel.com>
1 parent a8029e0 commit 870f458

12 files changed

Lines changed: 16 additions & 16 deletions

‎developer_guides/firmware/dcblock.rst‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -309,7 +309,7 @@ Sound Open Firmware provides standard tuning presets configured for common sampl
309309
- 0.9922
310310
- 0.9974
311311
- ~37 ms
312-
- High-fidelity music playback, studio monitors, mastering pipelines.
312+
- High-fidelity music playback, studio monitors, audio post-production pipelines.
313313
* - **40 Hz**
314314
- 0.9844
315315
- 0.9948

‎developer_guides/firmware/images/hostless_clocking_audio_bridges.svg‎

Lines changed: 1 addition & 1 deletion
Loading

‎developer_guides/firmware/images/hostless_system_architecture.svg‎

Lines changed: 2 additions & 2 deletions
Loading

‎developer_guides/firmware/pcm_converter.rst‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -585,7 +585,7 @@ Channel routing is governed by a packed 32-bit configuration word (``chmap``). E
585585
* **Nibble 0** (Bits 3..0): Specifies the source channel index copied into Sink Channel 0.
586586
* **Nibble 1** (Bits 7..4): Specifies the source channel index copied into Sink Channel 1.
587587
* **Nibble** :math:`k` (Bits :math:`4k+3 \dots 4k`): Specifies the source channel index copied into Sink Channel :math:`k`.
588-
* **The Identity Mapping** (``DUMMY_CHMAP``):
588+
* **The Identity Mapping** (``IDENTITY_CHMAP``):
589589
``0x76543210`` maps source channel 0 to sink 0, source 1 to sink 1, up to source 7 to sink 7.
590590

591591
The Special ``0xF`` Mute Nibble & Out-of-Bounds Protection

‎developer_guides/firmware/rtnr.rst‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -545,7 +545,7 @@ To ensure that the open-source community, continuous integration (CI) test matri
545545
void RTKMA_API_S32_Default(...);
546546
547547
* **Circular Buffer Passthrough**:
548-
Rather than performing dummy mathematical operations, the stub executes ``rtnr_stub_passthrough``, invoking ``cir_buf_copy`` across the ``audio_stream_rtnr`` descriptors:
548+
Rather than performing placeholder mathematical operations, the stub executes ``rtnr_stub_passthrough``, invoking ``cir_buf_copy`` across the ``audio_stream_rtnr`` descriptors:
549549

550550
.. math::
551551

‎developer_guides/rimage/index.rst‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -317,7 +317,7 @@ C Preprocessor TOML Templates (``*.toml.h``)
317317

318318
To synchronize firmware module IDs and Kconfig features with Rimage, platform templates (e.g. ``ptl.toml.h``) leverage the C preprocessor:
319319

320-
.. code-block:: c
320+
.. code-block:: text
321321
322322
/* Excerpt from ptl.toml.h */
323323
#include "platform-ptl.toml"

‎developer_guides/testbench/build_testbench.rst‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
Build and Run Testbench
44
#######################
55

6-
This guide covers building the SOF Testbench from source, preparing audio test streams, executing native simulations, and running quick sanity checks.
6+
This guide covers building the SOF Testbench from source, preparing audio test streams, executing native simulations, and running quick verification checks.
77

88
Prerequisites and System Dependencies
99
*************************************
@@ -78,10 +78,10 @@ For fine-grained control over compiler flags, sanitizers, or build types:
7878
# Compile and install
7979
cmake --build build_testbench -j$(nproc) --target install
8080
81-
Quick Sanity Verification (``host-testbench.sh``)
82-
*************************************************
81+
Quick Verification (``host-testbench.sh``)
82+
*******************************************
8383

84-
To confirm that the testbench build and audio processing components are functioning properly, execute the quick sanity script:
84+
To confirm that the testbench build and audio processing components are functioning properly, execute the quick verification script:
8585

8686
.. code-block:: bash
8787

‎developer_guides/testbench/images/testbench_system_architecture.svg‎

Lines changed: 1 addition & 1 deletion
Loading

‎developer_guides/testbench/index.rst‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -165,7 +165,7 @@ SOF provides three standard wrapper scripts located in ``scripts/`` to streamlin
165165
2. ``scripts/sof-testbench-helper.sh``:
166166
High-level test runner that handles WAV-to-RAW audio format conversions via ``sox``, locates default component benchmark topologies, executes testbench, and converts output back to WAV with a single command.
167167
3. ``scripts/host-testbench.sh``:
168-
Quick sanity test suite that compiles and runs smoke tests for Volume, SRC, and IIR Equalizer components, verifying exit codes and output file sizes.
168+
Quick verification test suite that compiles and runs smoke tests for Volume, SRC, and IIR Equalizer components, verifying exit codes and output file sizes.
169169

170170
Quick Start: Simulating an Audio Pipeline
171171
*****************************************

‎developer_guides/testing/images/hardware_loopback_clocking_modes.svg‎

Lines changed: 1 addition & 1 deletion
Loading

0 commit comments

Comments
 (0)