[Intel-wired-lan] [next v2] docs/networking: fix formatting of Intel drivers documentation
Brown, Aaron F
aaron.f.brown at intel.com
Fri Feb 1 23:47:00 UTC 2019
> From: Intel-wired-lan [mailto:intel-wired-lan-bounces at osuosl.org] On
> Behalf Of Jeff Kirsher
> Sent: Wednesday, December 12, 2018 2:44 PM
> To: intel-wired-lan at lists.osuosl.org
> Cc: Mike Rapoport <rppt at linux.ibm.com>
> Subject: [Intel-wired-lan] [next v2] docs/networking: fix formatting of Intel
> drivers documentation
>
> From: Mike Rapoport <rppt at linux.ibm.com>
>
> The documentation of Intel drivers is missing the heading adornment for
> document titles.
>
> This causes the generated html to have TOC entries from these documents
> to
> appear as top level TOC entries:
>
> * Linux* Base Driver for Intel(R) Ethernet Network Connection
> * Contents
> * Identifying Your Adapter
> * Command Line Parameters
> * AutoNeg
> * Duplex
> ...
>
> Add overline heading adornment to document titles.
>
> Signed-off-by: Mike Rapoport <rppt at linux.ibm.com>
> ---
> v2: update the Documentation path with the current net-next tree
>
> Another interesting thing is that many of these documents have very similar
> or even identical titles.
> It would be nice to include the adapter name in the titles to make them
> distinguishable.
>
> Documentation/networking/device_drivers/intel/e100.rst | 1 +
> Documentation/networking/device_drivers/intel/e1000.rst | 1 +
> Documentation/networking/device_drivers/intel/e1000e.rst | 1 +
> Documentation/networking/device_drivers/intel/fm10k.rst | 1 +
> Documentation/networking/device_drivers/intel/i40e.rst | 1 +
> Documentation/networking/device_drivers/intel/iavf.rst | 1 +
> Documentation/networking/device_drivers/intel/ice.rst | 1 +
> Documentation/networking/device_drivers/intel/igb.rst | 1 +
> Documentation/networking/device_drivers/intel/igbvf.rst | 1 +
> Documentation/networking/device_drivers/intel/ixgb.rst | 1 +
> Documentation/networking/device_drivers/intel/ixgbe.rst | 1 +
> Documentation/networking/device_drivers/intel/ixgbevf.rst | 1 +
> 12 files changed, 12 insertions(+)
>
Tested-by: Aaron Brown <aaron.f.brown at intel.com>
More information about the Intel-wired-lan
mailing list