2019-04-19 22:56:43

by Mauro Carvalho Chehab

[permalink] [raw]
Subject: [PATCH 1/2] docs: doc-guide: remove the extension from .rst files

On almost all places, we're including ReST files without the
extension.

Let's remove the extension here as well, in order to use just
one standard.

Suggested-by: Jani Nikula <[email protected]>
Signed-off-by: Mauro Carvalho Chehab <[email protected]>
---
Documentation/doc-guide/index.rst | 6 +++---
1 file changed, 3 insertions(+), 3 deletions(-)

diff --git a/Documentation/doc-guide/index.rst b/Documentation/doc-guide/index.rst
index a7f95d7d3a63..603f3ff55d5a 100644
--- a/Documentation/doc-guide/index.rst
+++ b/Documentation/doc-guide/index.rst
@@ -7,9 +7,9 @@ How to write kernel documentation
.. toctree::
:maxdepth: 1

- sphinx.rst
- kernel-doc.rst
- parse-headers.rst
+ sphinx
+ kernel-doc
+ parse-headers

.. only:: subproject and html

--
2.20.1



2019-04-19 18:48:13

by Jonathan Corbet

[permalink] [raw]
Subject: Re: [PATCH 1/2] docs: doc-guide: remove the extension from .rst files

On Fri, 19 Apr 2019 07:30:51 -0300
Mauro Carvalho Chehab <[email protected]> wrote:

> On almost all places, we're including ReST files without the
> extension.
>
> Let's remove the extension here as well, in order to use just
> one standard.
>
> Suggested-by: Jani Nikula <[email protected]>
> Signed-off-by: Mauro Carvalho Chehab <[email protected]>

I've applied this; I'll leave the hwmon one for Guenter.

Thanks,

jon

2019-04-19 19:08:36

by Jean Delvare

[permalink] [raw]
Subject: Re: [PATCH 2/2] docs: hwmon: remove the extension from .rst files

On Fri, 2019-04-19 at 07:30 -0300, Mauro Carvalho Chehab wrote:
> On almost all places, we're including ReST files without the
> extension.
>
> Let's remove the extension here as well, in order to use just
> one standard.
>

Tab in the middle of a sentence.

> Suggested-by: Jani Nikula <[email protected].
>

The line above appears to be truncated.

> Signed-off-by: Mauro Carvalho Chehab <[email protected]>
> ---
> Documentation/hwmon/index.rst | 316 +++++++++++++++++-----------------
> 1 file changed, 158 insertions(+), 158 deletions(-)

--
Jean Delvare
SUSE L3 Support

2019-04-19 22:55:35

by Mauro Carvalho Chehab

[permalink] [raw]
Subject: [PATCH 2/2] docs: hwmon: remove the extension from .rst files

On almost all places, we're including ReST files without the
extension.

Let's remove the extension here as well, in order to use just
one standard.

Suggested-by: Jani Nikula <[email protected].
Signed-off-by: Mauro Carvalho Chehab <[email protected]>
---
Documentation/hwmon/index.rst | 316 +++++++++++++++++-----------------
1 file changed, 158 insertions(+), 158 deletions(-)

diff --git a/Documentation/hwmon/index.rst b/Documentation/hwmon/index.rst
index 893804414510..bc74c43e3e2c 100644
--- a/Documentation/hwmon/index.rst
+++ b/Documentation/hwmon/index.rst
@@ -5,11 +5,11 @@ Linux Hardware Monitoring
.. toctree::
:maxdepth: 1

- hwmon-kernel-api.rst
- pmbus-core.rst
- submitting-patches.rst
- sysfs-interface.rst
- userspace-tools.rst
+ hwmon-kernel-api
+ pmbus-core
+ submitting-patches
+ sysfs-interface
+ userspace-tools

Hardware Monitoring Kernel Drivers
==================================
@@ -17,159 +17,159 @@ Hardware Monitoring Kernel Drivers
.. toctree::
:maxdepth: 1

- ab8500.rst
- abituguru.rst
- abituguru3.rst
- abx500.rst
- acpi_power_meter.rst
- ad7314.rst
- adc128d818.rst
- adm1021.rst
- adm1025.rst
- adm1026.rst
- adm1031.rst
- adm1275.rst
- adm9240.rst
- ads1015.rst
- ads7828.rst
- adt7410.rst
- adt7411.rst
- adt7462.rst
- adt7470.rst
- adt7475.rst
- amc6821.rst
- asb100.rst
- asc7621.rst
- aspeed-pwm-tacho.rst
- coretemp.rst
- da9052.rst
- da9055.rst
- dme1737.rst
- ds1621.rst
- ds620.rst
- emc1403.rst
- emc2103.rst
- emc6w201.rst
- f71805f.rst
- f71882fg.rst
- fam15h_power.rst
- ftsteutates.rst
- g760a.rst
- g762.rst
- gl518sm.rst
- hih6130.rst
- ibmaem.rst
- ibm-cffps.rst
- ibmpowernv.rst
- ina209.rst
- ina2xx.rst
- ina3221.rst
- ir35221.rst
- it87.rst
- jc42.rst
- k10temp.rst
- k8temp.rst
- lineage-pem.rst
- lm25066.rst
- lm63.rst
- lm70.rst
- lm73.rst
- lm75.rst
- lm77.rst
- lm78.rst
- lm80.rst
- lm83.rst
- lm85.rst
- lm87.rst
- lm90.rst
- lm92.rst
- lm93.rst
- lm95234.rst
- lm95245.rst
- ltc2945.rst
- ltc2978.rst
- ltc2990.rst
- ltc3815.rst
- ltc4151.rst
- ltc4215.rst
- ltc4245.rst
- ltc4260.rst
- ltc4261.rst
- max16064.rst
- max16065.rst
- max1619.rst
- max1668.rst
- max197.rst
- max20751.rst
- max31722.rst
- max31785.rst
- max31790.rst
- max34440.rst
- max6639.rst
- max6642.rst
- max6650.rst
- max6697.rst
- max8688.rst
- mc13783-adc.rst
- mcp3021.rst
- menf21bmc.rst
- mlxreg-fan.rst
- nct6683.rst
- nct6775.rst
- nct7802.rst
- nct7904.rst
- npcm750-pwm-fan.rst
- nsa320.rst
- ntc_thermistor.rst
- occ.rst
- pc87360.rst
- pc87427.rst
- pcf8591.rst
- pmbus.rst
- powr1220.rst
- pwm-fan.rst
- raspberrypi-hwmon.rst
- sch5627.rst
- sch5636.rst
- scpi-hwmon.rst
- sht15.rst
- sht21.rst
- sht3x.rst
- shtc1.rst
- sis5595.rst
- smm665.rst
- smsc47b397.rst
- smsc47m192.rst
- smsc47m1.rst
- tc654.rst
- tc74.rst
- thmc50.rst
- tmp102.rst
- tmp103.rst
- tmp108.rst
- tmp401.rst
- tmp421.rst
- tps40422.rst
- twl4030-madc-hwmon.rst
- ucd9000.rst
- ucd9200.rst
- vexpress.rst
- via686a.rst
- vt1211.rst
- w83627ehf.rst
- w83627hf.rst
- w83773g.rst
- w83781d.rst
- w83791d.rst
- w83792d.rst
- w83793.rst
- w83795.rst
- w83l785ts.rst
- w83l786ng.rst
- wm831x.rst
- wm8350.rst
- xgene-hwmon.rst
- zl6100.rst
+ ab8500
+ abituguru
+ abituguru3
+ abx500
+ acpi_power_meter
+ ad7314
+ adc128d818
+ adm1021
+ adm1025
+ adm1026
+ adm1031
+ adm1275
+ adm9240
+ ads1015
+ ads7828
+ adt7410
+ adt7411
+ adt7462
+ adt7470
+ adt7475
+ amc6821
+ asb100
+ asc7621
+ aspeed-pwm-tacho
+ coretemp
+ da9052
+ da9055
+ dme1737
+ ds1621
+ ds620
+ emc1403
+ emc2103
+ emc6w201
+ f71805f
+ f71882fg
+ fam15h_power
+ ftsteutates
+ g760a
+ g762
+ gl518sm
+ hih6130
+ ibmaem
+ ibm-cffps
+ ibmpowernv
+ ina209
+ ina2xx
+ ina3221
+ ir35221
+ it87
+ jc42
+ k10temp
+ k8temp
+ lineage-pem
+ lm25066
+ lm63
+ lm70
+ lm73
+ lm75
+ lm77
+ lm78
+ lm80
+ lm83
+ lm85
+ lm87
+ lm90
+ lm92
+ lm93
+ lm95234
+ lm95245
+ ltc2945
+ ltc2978
+ ltc2990
+ ltc3815
+ ltc4151
+ ltc4215
+ ltc4245
+ ltc4260
+ ltc4261
+ max16064
+ max16065
+ max1619
+ max1668
+ max197
+ max20751
+ max31722
+ max31785
+ max31790
+ max34440
+ max6639
+ max6642
+ max6650
+ max6697
+ max8688
+ mc13783-adc
+ mcp3021
+ menf21bmc
+ mlxreg-fan
+ nct6683
+ nct6775
+ nct7802
+ nct7904
+ npcm750-pwm-fan
+ nsa320
+ ntc_thermistor
+ occ
+ pc87360
+ pc87427
+ pcf8591
+ pmbus
+ powr1220
+ pwm-fan
+ raspberrypi-hwmon
+ sch5627
+ sch5636
+ scpi-hwmon
+ sht15
+ sht21
+ sht3x
+ shtc1
+ sis5595
+ smm665
+ smsc47b397
+ smsc47m192
+ smsc47m1
+ tc654
+ tc74
+ thmc50
+ tmp102
+ tmp103
+ tmp108
+ tmp401
+ tmp421
+ tps40422
+ twl4030-madc-hwmon
+ ucd9000
+ ucd9200
+ vexpress
+ via686a
+ vt1211
+ w83627ehf
+ w83627hf
+ w83773g
+ w83781d
+ w83791d
+ w83792d
+ w83793
+ w83795
+ w83l785ts
+ w83l786ng
+ wm831x
+ wm8350
+ xgene-hwmon
+ zl6100

.. only:: subproject and html

--
2.20.1


2019-04-22 11:35:24

by Mauro Carvalho Chehab

[permalink] [raw]
Subject: [PATCH] docs: hwmon: remove the extension from .rst files

On almost all places, we're including ReST files without the
extension.

Let's remove the extension here as well, in order to use just
one standard.

Suggested-by: Jani Nikula <[email protected]>
Signed-off-by: Mauro Carvalho Chehab <[email protected]>
---
Documentation/hwmon/index.rst | 322 +++++++++++++++++-----------------
1 file changed, 161 insertions(+), 161 deletions(-)

diff --git a/Documentation/hwmon/index.rst b/Documentation/hwmon/index.rst
index 3fa14fe7b49c..ee090e51653a 100644
--- a/Documentation/hwmon/index.rst
+++ b/Documentation/hwmon/index.rst
@@ -5,11 +5,11 @@ Linux Hardware Monitoring
.. toctree::
:maxdepth: 1

- hwmon-kernel-api.rst
- pmbus-core.rst
- submitting-patches.rst
- sysfs-interface.rst
- userspace-tools.rst
+ hwmon-kernel-api
+ pmbus-core
+ submitting-patches
+ sysfs-interface
+ userspace-tools

Hardware Monitoring Kernel Drivers
==================================
@@ -17,162 +17,162 @@ Hardware Monitoring Kernel Drivers
.. toctree::
:maxdepth: 1

- ab8500.rst
- abituguru.rst
- abituguru3.rst
- abx500.rst
- acpi_power_meter.rst
- ad7314.rst
- adc128d818.rst
- adm1021.rst
- adm1025.rst
- adm1026.rst
- adm1031.rst
- adm1275.rst
- adm9240.rst
- ads1015.rst
- ads7828.rst
- adt7410.rst
- adt7411.rst
- adt7462.rst
- adt7470.rst
- adt7475.rst
- amc6821.rst
- asb100.rst
- asc7621.rst
- aspeed-pwm-tacho.rst
- coretemp.rst
- da9052.rst
- da9055.rst
- dme1737.rst
- ds1621.rst
- ds620.rst
- emc1403.rst
- emc2103.rst
- emc6w201.rst
- f71805f.rst
- f71882fg.rst
- fam15h_power.rst
- ftsteutates.rst
- g760a.rst
- g762.rst
- gl518sm.rst
- hih6130.rst
- ibmaem.rst
- ibm-cffps.rst
- ibmpowernv.rst
- ina209.rst
- ina2xx.rst
- ina3221.rst
- ir35221.rst
- ir38064.rst
- isl68137.rst
- it87.rst
- jc42.rst
- k10temp.rst
- k8temp.rst
- lineage-pem.rst
- lm25066.rst
- lm63.rst
- lm70.rst
- lm73.rst
- lm75.rst
- lm77.rst
- lm78.rst
- lm80.rst
- lm83.rst
- lm85.rst
- lm87.rst
- lm90.rst
- lm92.rst
- lm93.rst
- lm95234.rst
- lm95245.rst
- lochnagar.rst
- ltc2945.rst
- ltc2978.rst
- ltc2990.rst
- ltc3815.rst
- ltc4151.rst
- ltc4215.rst
- ltc4245.rst
- ltc4260.rst
- ltc4261.rst
- max16064.rst
- max16065.rst
- max1619.rst
- max1668.rst
- max197.rst
- max20751.rst
- max31722.rst
- max31785.rst
- max31790.rst
- max34440.rst
- max6639.rst
- max6642.rst
- max6650.rst
- max6697.rst
- max8688.rst
- mc13783-adc.rst
- mcp3021.rst
- menf21bmc.rst
- mlxreg-fan.rst
- nct6683.rst
- nct6775.rst
- nct7802.rst
- nct7904.rst
- npcm750-pwm-fan.rst
- nsa320.rst
- ntc_thermistor.rst
- occ.rst
- pc87360.rst
- pc87427.rst
- pcf8591.rst
- pmbus.rst
- powr1220.rst
- pwm-fan.rst
- raspberrypi-hwmon.rst
- sch5627.rst
- sch5636.rst
- scpi-hwmon.rst
- sht15.rst
- sht21.rst
- sht3x.rst
- shtc1.rst
- sis5595.rst
- smm665.rst
- smsc47b397.rst
- smsc47m192.rst
- smsc47m1.rst
- tc654.rst
- tc74.rst
- thmc50.rst
- tmp102.rst
- tmp103.rst
- tmp108.rst
- tmp401.rst
- tmp421.rst
- tps40422.rst
- twl4030-madc-hwmon.rst
- ucd9000.rst
- ucd9200.rst
- vexpress.rst
- via686a.rst
- vt1211.rst
- w83627ehf.rst
- w83627hf.rst
- w83773g.rst
- w83781d.rst
- w83791d.rst
- w83792d.rst
- w83793.rst
- w83795.rst
- w83l785ts.rst
- w83l786ng.rst
- wm831x.rst
- wm8350.rst
- xgene-hwmon.rst
- zl6100.rst
+ ab8500
+ abituguru
+ abituguru3
+ abx500
+ acpi_power_meter
+ ad7314
+ adc128d818
+ adm1021
+ adm1025
+ adm1026
+ adm1031
+ adm1275
+ adm9240
+ ads1015
+ ads7828
+ adt7410
+ adt7411
+ adt7462
+ adt7470
+ adt7475
+ amc6821
+ asb100
+ asc7621
+ aspeed-pwm-tacho
+ coretemp
+ da9052
+ da9055
+ dme1737
+ ds1621
+ ds620
+ emc1403
+ emc2103
+ emc6w201
+ f71805f
+ f71882fg
+ fam15h_power
+ ftsteutates
+ g760a
+ g762
+ gl518sm
+ hih6130
+ ibmaem
+ ibm-cffps
+ ibmpowernv
+ ina209
+ ina2xx
+ ina3221
+ ir35221
+ ir38064
+ isl68137
+ it87
+ jc42
+ k10temp
+ k8temp
+ lineage-pem
+ lm25066
+ lm63
+ lm70
+ lm73
+ lm75
+ lm77
+ lm78
+ lm80
+ lm83
+ lm85
+ lm87
+ lm90
+ lm92
+ lm93
+ lm95234
+ lm95245
+ lochnagar
+ ltc2945
+ ltc2978
+ ltc2990
+ ltc3815
+ ltc4151
+ ltc4215
+ ltc4245
+ ltc4260
+ ltc4261
+ max16064
+ max16065
+ max1619
+ max1668
+ max197
+ max20751
+ max31722
+ max31785
+ max31790
+ max34440
+ max6639
+ max6642
+ max6650
+ max6697
+ max8688
+ mc13783-adc
+ mcp3021
+ menf21bmc
+ mlxreg-fan
+ nct6683
+ nct6775
+ nct7802
+ nct7904
+ npcm750-pwm-fan
+ nsa320
+ ntc_thermistor
+ occ
+ pc87360
+ pc87427
+ pcf8591
+ pmbus
+ powr1220
+ pwm-fan
+ raspberrypi-hwmon
+ sch5627
+ sch5636
+ scpi-hwmon
+ sht15
+ sht21
+ sht3x
+ shtc1
+ sis5595
+ smm665
+ smsc47b397
+ smsc47m192
+ smsc47m1
+ tc654
+ tc74
+ thmc50
+ tmp102
+ tmp103
+ tmp108
+ tmp401
+ tmp421
+ tps40422
+ twl4030-madc-hwmon
+ ucd9000
+ ucd9200
+ vexpress
+ via686a
+ vt1211
+ w83627ehf
+ w83627hf
+ w83773g
+ w83781d
+ w83791d
+ w83792d
+ w83793
+ w83795
+ w83l785ts
+ w83l786ng
+ wm831x
+ wm8350
+ xgene-hwmon
+ zl6100

.. only:: subproject and html

--
2.20.1

2019-04-22 17:37:41

by Guenter Roeck

[permalink] [raw]
Subject: Re: [PATCH] docs: hwmon: remove the extension from .rst files

On Mon, Apr 22, 2019 at 08:14:55AM -0300, Mauro Carvalho Chehab wrote:
> On almost all places, we're including ReST files without the
> extension.
>
> Let's remove the extension here as well, in order to use just
> one standard.
>
> Suggested-by: Jani Nikula <[email protected]>
> Signed-off-by: Mauro Carvalho Chehab <[email protected]>
> ---
> Documentation/hwmon/index.rst | 322 +++++++++++++++++-----------------
> 1 file changed, 161 insertions(+), 161 deletions(-)
>
> diff --git a/Documentation/hwmon/index.rst b/Documentation/hwmon/index.rst
> index 3fa14fe7b49c..ee090e51653a 100644
> --- a/Documentation/hwmon/index.rst
> +++ b/Documentation/hwmon/index.rst
> @@ -5,11 +5,11 @@ Linux Hardware Monitoring
> .. toctree::
> :maxdepth: 1
>
...
> - ir38064.rst
> - isl68137.rst
...
> - lochnagar.rst

You never actually sent the patches to convert the above files to .rst.
It looks like you did convert the files in your tree and added them to
the index. Since I don't have those patches, this patch does not apply.

Guenter

2019-04-22 17:43:25

by Mauro Carvalho Chehab

[permalink] [raw]
Subject: Re: [PATCH] docs: hwmon: remove the extension from .rst files

Em Mon, 22 Apr 2019 10:35:34 -0700
Guenter Roeck <[email protected]> escreveu:

> On Mon, Apr 22, 2019 at 08:14:55AM -0300, Mauro Carvalho Chehab wrote:
> > On almost all places, we're including ReST files without the
> > extension.
> >
> > Let's remove the extension here as well, in order to use just
> > one standard.
> >
> > Suggested-by: Jani Nikula <[email protected]>
> > Signed-off-by: Mauro Carvalho Chehab <[email protected]>
> > ---
> > Documentation/hwmon/index.rst | 322 +++++++++++++++++-----------------
> > 1 file changed, 161 insertions(+), 161 deletions(-)
> >
> > diff --git a/Documentation/hwmon/index.rst b/Documentation/hwmon/index.rst
> > index 3fa14fe7b49c..ee090e51653a 100644
> > --- a/Documentation/hwmon/index.rst
> > +++ b/Documentation/hwmon/index.rst
> > @@ -5,11 +5,11 @@ Linux Hardware Monitoring
> > .. toctree::
> > :maxdepth: 1
> >
> ...
> > - ir38064.rst
> > - isl68137.rst
> ...
> > - lochnagar.rst
>
> You never actually sent the patches to convert the above files to .rst.
> It looks like you did convert the files in your tree and added them to
> the index. Since I don't have those patches, this patch does not apply.

I'm pretty sure I sent you last week, as Jani replied on it asking for
the .rst removal.

Anyway it is just one file. I'll just send it again.

Subject: [PATCH] docs: hwmon: convert three docs to ReST format

Regards,
Mauro

>
> Guenter



Thanks,
Mauro

2019-04-23 01:31:31

by Guenter Roeck

[permalink] [raw]
Subject: Re: [PATCH] docs: hwmon: remove the extension from .rst files

On Mon, Apr 22, 2019 at 08:14:55AM -0300, Mauro Carvalho Chehab wrote:
> On almost all places, we're including ReST files without the
> extension.
>
> Let's remove the extension here as well, in order to use just
> one standard.
>
> Suggested-by: Jani Nikula <[email protected]>
> Signed-off-by: Mauro Carvalho Chehab <[email protected]>

Applied to hwmon-next.

Thanks,
Guenter