linux-toradex.git/Documentation/w1, branch master

Documentation: use a source-read extension for the index link boilerplate

2026-01-23T18:59:34+00:00

The root document usually has a special :ref:`genindex` link to the
generated index. This is also the case for Documentation/index.rst. The
other index.rst files deeper in the directory hierarchy usually don't.

For SPHINXDIRS builds, the root document isn't Documentation/index.rst,
but some other index.rst in the hierarchy. Currently they have a
".. only::" block to add the index link when doing SPHINXDIRS html
builds.

This is obviously very tedious and repetitive. The link is also added to
all index.rst files in the hierarchy for SPHINXDIRS builds, not just the
root document.

Put the boilerplate in a sphinx-includes/subproject-index.rst file, and
include it at the end of the root document for subproject builds in an
ad-hoc source-read extension defined in conf.py.

For now, keep having the boilerplate in translations, because this
approach currently doesn't cover translated index link headers.

Cc: Jonathan Corbet 
Cc: Mauro Carvalho Chehab 
Cc: Randy Dunlap 
Signed-off-by: Jani Nikula 
Tested-by: Mauro Carvalho Chehab 
Reviewed-by: Mauro Carvalho Chehab 
[jc: did s/doctree/kern_doc_dir/ ]
Signed-off-by: Jonathan Corbet 
Message-ID: <20260123143149.2024303-1-jani.nikula@intel.com>

docs: w1: fix w1-netlink invalid URL

2025-11-05T18:23:39+00:00

The URL in w1-netlink.rst for an example userspace application
has changed. The former URL is no longer valid. Update it to the
github URL.

Fixes: e4e056aa3518 ("w1: documentation update")
Signed-off-by: Randy Dunlap 
Signed-off-by: Jonathan Corbet 
Message-ID: <20251104194403.945611-1-rdunlap@infradead.org>

docs: w1: ds2482: fix typo in buses

2025-09-16T16:00:57+00:00

Correct a spelling mistake in ds2482.rst
("busses" -> "buses").

No functional change.

Signed-off-by: Akiyoshi Kurita 
Signed-off-by: Jonathan Corbet 
Message-ID: <20250913173413.951378-1-weibu@redadmin.org>

Documentation: w1: Fix SPDX comment syntax on masters and slaves toctree index

2025-09-09T18:57:07+00:00

Commit e9bb627561535d ("docs: w1: convert to ReST and add to the kAPI
group of docs") converts 1-Wire docs to reST alongside with SPDX
comment, yet the comment is written in one dot as opposed to two in
order to be recognized as comment directive, which spills it into
htmldocs output. This issue is partially fixed in d8fb03e1ea64e7 ("docs:
w1: Fix SPDX-License-Identifier syntax") as it only touches top-level w1
toctree.

Do the same fix on masters and slaves toctrees.

Fixes: e9bb62756153 ("docs: w1: convert to ReST and add to the kAPI group of docs")
Signed-off-by: Bagas Sanjaya 
Reviewed-by: Krzysztof Kozlowski 
Signed-off-by: Jonathan Corbet 
Message-ID: <20250909022142.18007-1-bagasdotme@gmail.com>

w1: add UART w1 bus driver

2024-02-15T14:02:33+00:00

Add a UART 1-Wire bus driver. The driver utilizes the UART interface via
the Serial Device Bus to create the 1-Wire timing patterns. The driver
was tested on a "Raspberry Pi 3B" with a DS18B20 and on a "Variscite
DART-6UL" with a DS18S20 temperature sensor.

The 1-Wire timing pattern and the corresponding UART baud-rate with the
interpretation of the transferred bytes are described in the document:

Link: https://www.analog.com/en/technical-articles/using-a-uart-to-implement-a-1wire-bus-master.html

In short, the UART peripheral must support full-duplex and operate in
open-drain mode. The timing patterns are generated by a specific
combination of baud-rate and transmitted byte, which corresponds to a
1-Wire read bit, write bit or reset.

Signed-off-by: Christoph Winklhofer 
Link: https://lore.kernel.org/r/20240214-w1-uart-v7-3-6e21fa24e066@gmail.com
[krzysztof: w1_uart_serdev_receive_buf() return type fixup]
Signed-off-by: Krzysztof Kozlowski

Documentation: Fix typos

2023-08-18T17:29:03+00:00

Fix typos in Documentation.

Signed-off-by: Bjorn Helgaas 
Link: https://lore.kernel.org/r/20230814212822.193684-4-helgaas@kernel.org
Signed-off-by: Jonathan Corbet

Documentation: W1: minor typo corrections

2022-09-27T19:21:44+00:00

Correct one typo/spello and remove one duplicated word in the
W1 documentation.

Signed-off-by: Randy Dunlap 
Cc: Jonathan Corbet 
Cc: linux-doc@vger.kernel.org
Cc: Evgeniy Polyakov 
Link: https://lore.kernel.org/r/20220828002845.7022-1-rdunlap@infradead.org
Signed-off-by: Jonathan Corbet

w1: w1_therm: Document Maxim MAX31850 thermoelement IF.

2022-04-05T16:19:42+00:00

w1_therm driver supports now MAX31850, too. Add it to documentation
and fix a small typo.

Signed-off-by: Markus Reichl 
Signed-off-by: Jonathan Corbet

dt-bindings: w1: update w1-gpio.yaml reference

2021-09-17T02:02:09+00:00

Changeset dd2c898bc20b ("dt-bindings: w1: Convert 1-Wire GPIO binding to a schema")
renamed: Documentation/devicetree/bindings/w1/w1-gpio.txt
to: Documentation/devicetree/bindings/w1/w1-gpio.yaml.

Update its cross-reference accordingly.

Fixes: dd2c898bc20b ("dt-bindings: w1: Convert 1-Wire GPIO binding to a schema")
Signed-off-by: Mauro Carvalho Chehab 
Signed-off-by: Rob Herring 
Link: https://lore.kernel.org/r/0b415b5e05bcf9d593cb421c96996d914528e732.1631785820.git.mchehab+huawei@kernel.org

w1: fix build warning in w1_ds2438.rst

2021-05-26T07:11:24+00:00

commit c999fbbdcf77 ("w1: ds2438: support for writing to offset
register") added more documentation, but had a one-off line for the
header of a section which caused the build warning:

	Documentation/w1/slaves/w1_ds2438.rst:56: WARNING: Title underline too short.

Resolve this by fixing the underline to be long enough.

Reported-by: Stephen Rothwell 
Link: https://lore.kernel.org/r/YKthRzCGan9WEcmP@kroah.com
Signed-off-by: Greg Kroah-Hartman