Skip to content

mass-import: Import dokuwiki pages to rst#3151

Open
gastmaier wants to merge 203 commits intocifrom
ci-docs-wiki-import
Open

mass-import: Import dokuwiki pages to rst#3151
gastmaier wants to merge 203 commits intocifrom
ci-docs-wiki-import

Conversation

@gastmaier
Copy link
Collaborator

PR Description

Import the pages under /linux-drivers/ at https://wiki.analog.com.

The import had 3 stages:

  • step0: fetch artifacts from dokuwiki to wiki, with grep /linux-drivers/ to wiki/ folder
  • step1: for wiki/* convert to rst with pandoc at rst/ folder
  • step2: copy to docs, build and interactively

Step 1 used the approach

  • pre-patch dokuwiki files: many wiki-roles were broken, many pages with many broken syntax.
    converted, with a lot of regex, to formats that are better parsable later on.
    There are 8 different "git-wiki-role" to create link roles.
  • pandoc convert to rst
  • pre-patch rst files: here we solve (cross-)references, and roles we
    propagated from the pre-patch dokuwiki, we resolve.

Step 2:

  • Build the docs, solve the warnings.
  • At the beginning, the fixes are made in the wiki/ files, and
    step1+step2 is run again (adoc serve catches the changes, rebuilds)
  • After the # of warnings are manageble and are things that really broken,
    I started to fix on the .rst files (not running step1 anymore), until reaching the final stage.

Unresolved issues are marked with the .. todo:: directive.

PR Type

  • Bug fix (a change that fixes an issue)
  • New feature (a change that adds new functionality)
  • Breaking change (a change that affects other repos or cause CIs to fail)

PR Checklist

  • I have conducted a self-review of my own code changes
  • I have compiled my changes, including the documentation
  • I have tested the changes on the relevant hardware
  • I have updated the documentation outside this repo accordingly
  • I have provided links for the relevant upstream lore

Add -jauto to SPHINXOPTS to build in parallel.

Signed-off-by: Jorge Marques <jorge.marques@analog.com>
Add todo directive extension to track todos.Add scopy and documentation
to interref_repos to cross-reference to them.

Signed-off-by: Jorge Marques <jorge.marques@analog.com>
Have drivers inside a drivers folder.

Signed-off-by: Jorge Marques <jorge.marques@analog.com>
Generated by the doc built.

Signed-off-by: Jorge Marques <jorge.marques@analog.com>
They provide iio and input snippets, shared need help and platforma and bus models.

Signed-off-by: Jorge Marques <jorge.marques@analog.com>
ADP8860 Back-light LED Linux Driver.

imported from:
https://wiki.analog.com/resources/tools-software/linux-drivers/backlight/adp8860

Signed-off-by: Jorge Marques <jorge.marques@analog.com>
ADP8870 Back-light LED Linux Driver.

imported from:
https://wiki.analog.com/resources/tools-software/linux-drivers/backlight/adp8870

Signed-off-by: Jorge Marques <jorge.marques@analog.com>
AD9545 Quad Input, 10-Output, Dual DPLL/IEEE 1588, 1 pps Synchronizer
and Jitter Cleaner.

imported from:
https://wiki.analog.com/resources/tools-software/linux-drivers/clk/adi/clk-ad9545/c

Signed-off-by: Jorge Marques <jorge.marques@analog.com>
PmodAD1IIO Oscilloscope Demo.

imported from:
https://wiki.analog.com/resources/tools-software/linux-drivers/demo/pmod-ad1-da1-demo

Signed-off-by: Jorge Marques <jorge.marques@analog.com>
Analog Device AXI-DMAC DMA Controller Linux Driver.

imported from:
https://wiki.analog.com/resources/tools-software/linux-drivers/axi-dmac

Signed-off-by: Jorge Marques <jorge.marques@analog.com>
ADV7511 HDMI transmitter Linux Driver.

imported from:
https://wiki.analog.com/resources/tools-software/linux-drivers/drm/adv7511

Signed-off-by: Jorge Marques <jorge.marques@analog.com>
AXI HDMI HDL Linux Driver.

imported from:
https://wiki.analog.com/resources/tools-software/linux-drivers/drm/hdl-axi-hdmi

Signed-off-by: Jorge Marques <jorge.marques@analog.com>
ADP5588 GPIO Linux Driver.

imported from:
https://wiki.analog.com/resources/tools-software/linux-drivers/gpio/adp5588-gpio

Signed-off-by: Jorge Marques <jorge.marques@analog.com>
AXI Fan Control HDL CORE Linux driver.

imported from:
https://wiki.analog.com/resources/tools-software/linux-drivers/hwmon/axi_fan_control

Signed-off-by: Jorge Marques <jorge.marques@analog.com>
LTC2947 High Precision Power and Energy Monitor Linux Driver.

imported from:
https://wiki.analog.com/resources/tools-software/linux-drivers/hwmon/ltc2947

Signed-off-by: Jorge Marques <jorge.marques@analog.com>
ADIS16201 IIO Dual-Axis Digital Inclinometer and Accelerometer Linux
Driver.

imported from:
https://wiki.analog.com/resources/tools-software/linux-drivers/iio-accelerometer/adis16201

Signed-off-by: Jorge Marques <jorge.marques@analog.com>
IIO Programmable 360 Degrees Inclinometer.

imported from:
https://wiki.analog.com/resources/tools-software/linux-drivers/iio-accelerometer/adis16203

Signed-off-by: Jorge Marques <jorge.marques@analog.com>
ADIS16209 IIO Accelerometer and Inclinometer.

imported from:
https://wiki.analog.com/resources/tools-software/linux-drivers/iio-accelerometer/adis16209

Signed-off-by: Jorge Marques <jorge.marques@analog.com>
ADIS16240 IIO Programmable Impact Sensor and Recorder.

imported from:
https://wiki.analog.com/resources/tools-software/linux-drivers/iio-accelerometer/adis16240

Signed-off-by: Jorge Marques <jorge.marques@analog.com>
ADXL312, ADXL313, ADXL314 Low Noise, Low Drift, Low Power, 3-Axis MEMS
Accelerometers.

imported from:
https://wiki.analog.com/resources/tools-software/linux-drivers/iio-accelerometer/adxl313

Signed-off-by: Jorge Marques <jorge.marques@analog.com>
ADXL355 Low Noise, Low Drift, Low Power, 3-Axis MEMS Accelerometers.

imported from:
https://wiki.analog.com/resources/tools-software/linux-drivers/iio-accelerometer/adxl355

Signed-off-by: Jorge Marques <jorge.marques@analog.com>
ADXL367 Input 3-Axis Digital Accelerometer Linux Driver.

imported from:
https://wiki.analog.com/resources/tools-software/linux-drivers/iio-accelerometer/adxl367

Signed-off-by: Jorge Marques <jorge.marques@analog.com>
ADXL372 Input 3-Axis Digital Accelerometer Linux Driver.

imported from:
https://wiki.analog.com/resources/tools-software/linux-drivers/iio-accelerometer/adxl372

Signed-off-by: Jorge Marques <jorge.marques@analog.com>
AD4003/AD4007/AD4011/AD4020/ADAQ4001/ADAQ4003 Linux Driver.

imported from:
https://wiki.analog.com/resources/tools-software/linux-drivers/iio-adc/ad400x

Signed-off-by: Jorge Marques <jorge.marques@analog.com>
AD4030/AD4630/ADAQ4216/ADAQ4224 ADC Linux Driver.

imported from:
https://wiki.analog.com/resources/tools-software/linux-drivers/iio-adc/ad4030

Signed-off-by: Jorge Marques <jorge.marques@analog.com>
AD4134 ADC Linux Driver.

imported from:
https://wiki.analog.com/resources/tools-software/linux-drivers/iio-adc/ad4134

Signed-off-by: Jorge Marques <jorge.marques@analog.com>
AD4170 24-Bit Sigma-Delta ADC with Integrated PGA Linux Driver.

imported from:
https://wiki.analog.com/resources/tools-software/linux-drivers/iio-adc/ad4170

Signed-off-by: Jorge Marques <jorge.marques@analog.com>
AD4630 ADC Linux Driver.

imported from:
https://wiki.analog.com/resources/tools-software/linux-drivers/iio-adc/ad4630

Signed-off-by: Jorge Marques <jorge.marques@analog.com>
AD4630-24/AD4630-16 Dual Channel and AD4030-24 Single Channel
Precision SAR ADC Linux Driver.

imported from:
https://wiki.analog.com/resources/tools-software/linux-drivers/iio-adc/ad463x

Signed-off-by: Jorge Marques <jorge.marques@analog.com>
AD469x Easy Drive Multiplexed SAR ADC Linux IIO Driver.

imported from:
https://wiki.analog.com/resources/tools-software/linux-drivers/iio-adc/ad4695

Signed-off-by: Jorge Marques <jorge.marques@analog.com>
ADAU1373 Sound CODEC Linux Driver.

imported from:
https://wiki.analog.com/resources/tools-software/linux-drivers/sound/adau1373

Signed-off-by: Jorge Marques <jorge.marques@analog.com>
ADAU1781 Sound CODEC Linux Driver.

imported from:
https://wiki.analog.com/resources/tools-software/linux-drivers/sound/adau1381

Signed-off-by: Jorge Marques <jorge.marques@analog.com>
ADAU1701 Sound Audio System Linux Driver.

imported from:
https://wiki.analog.com/resources/tools-software/linux-drivers/sound/adau1701

Signed-off-by: Jorge Marques <jorge.marques@analog.com>
ADAU1860 Sound CODEC Linux Driver.

imported from:
https://wiki.analog.com/resources/tools-software/linux-drivers/sound/adau1860

Signed-off-by: Jorge Marques <jorge.marques@analog.com>
ADAU1977 Sound CODEC Linux Driver.

imported from:
https://wiki.analog.com/resources/tools-software/linux-drivers/sound/adau1977

Signed-off-by: Jorge Marques <jorge.marques@analog.com>
ADAU7002 Stereo PDM to I2S or TDM Conversion IC Linux Driver.

imported from:
https://wiki.analog.com/resources/tools-software/linux-drivers/sound/adau7002

Signed-off-by: Jorge Marques <jorge.marques@analog.com>
ADAU7118 8 Channel, PDM to I2S or TDM Conversion IC Linux Driver.

imported from:
https://wiki.analog.com/resources/tools-software/linux-drivers/sound/adau7118

Signed-off-by: Jorge Marques <jorge.marques@analog.com>
ADAV80X Sound CODEC Linux Driver.

imported from:
https://wiki.analog.com/resources/tools-software/linux-drivers/sound/adav801

Signed-off-by: Jorge Marques <jorge.marques@analog.com>
HDL AXI I2S Linux Driver.

imported from:
https://wiki.analog.com/resources/tools-software/linux-drivers/sound/hdl-axi-i2s

Signed-off-by: Jorge Marques <jorge.marques@analog.com>
HDL AXI SPIDF Linux Driver.

imported from:
https://wiki.analog.com/resources/tools-software/linux-drivers/sound/hdl-axi-spidf

Signed-off-by: Jorge Marques <jorge.marques@analog.com>
SSM2518 Sound CODEC Linux Driver.

imported from:
https://wiki.analog.com/resources/tools-software/linux-drivers/sound/ssm2518

Signed-off-by: Jorge Marques <jorge.marques@analog.com>
SSM2602 Sound CODEC Linux Driver.

imported from:
https://wiki.analog.com/resources/tools-software/linux-drivers/sound/ssm2602

Signed-off-by: Jorge Marques <jorge.marques@analog.com>
SSM4329 Sound CODEC Linux Driver.

imported from:
https://wiki.analog.com/resources/tools-software/linux-drivers/sound/ssm4329

Signed-off-by: Jorge Marques <jorge.marques@analog.com>
SSM4567 Audio Amplifier Linux Driver.

imported from:
https://wiki.analog.com/resources/tools-software/linux-drivers/sound/ssm4567

Signed-off-by: Jorge Marques <jorge.marques@analog.com>
SPI Engine Peripheral Linux Driver.

imported from:
https://wiki.analog.com/resources/tools-software/linux-drivers/spi/spi_engine

Signed-off-by: Jorge Marques <jorge.marques@analog.com>
Signed-off-by: Jorge Marques <jorge.marques@analog.com>
Signed-off-by: Jorge Marques <jorge.marques@analog.com>
Signed-off-by: Jorge Marques <jorge.marques@analog.com>
Signed-off-by: Jorge Marques <jorge.marques@analog.com>
Signed-off-by: Jorge Marques <jorge.marques@analog.com>
Signed-off-by: Jorge Marques <jorge.marques@analog.com>
Signed-off-by: Jorge Marques <jorge.marques@analog.com>
@gastmaier gastmaier marked this pull request as ready for review February 26, 2026 11:40
@gastmaier
Copy link
Collaborator Author

Pushed fixups to resolve the ..todo scrape>, intentionally to autosquash

@gastmaier gastmaier requested a review from pamolloy February 26, 2026 12:44
@pamolloy
Copy link
Collaborator

pamolloy commented Mar 1, 2026

Since I can't comment on the diff because it is too big... 😵

There is an extra ]] here:

- :git-linux:`dev_ad4170:drivers/iio/adc/ad4170.c]]`

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants