Skip to contentSkip to conversation

man: rewrite manual pages in reStructuredText

PATCH In review Jani Nikula 1 participant 3 messages Mar 1, 2016 – Mar 3, 2016

lore
Share & tools
lore
#0 lore raw

PATCH 1/2 man: rewrite manual pages in reStructuredText

intel_reg.rst was the first man page written in reStructuredText. Follow suit with the rest of the man pages.

Add a generated defs.rst include file for definitions such as intel-gpu-tools version. This replaces the MAN_SUBSTS sed script substitutions from xorg-macros for old man pages.

---
 man/Makefile.am                     | 62 ++++++++++++++---------------
 man/intel_aubdump.man               | 38 ------------------
 man/intel_aubdump.rst               | 55 ++++++++++++++++++++++++++
 man/intel_audio_dump.man            | 11 ------
 man/intel_audio_dump.rst            | 30 ++++++++++++++
 man/intel_bios_dumper.man           | 14 -------
 man/intel_bios_dumper.rst           | 36 +++++++++++++++++
 man/intel_bios_reader.man           | 15 -------
 man/intel_bios_reader.rst           | 37 +++++++++++++++++
 man/intel_error_decode.man          | 20 ----------
 man/intel_error_decode.rst          | 38 ++++++++++++++++++
 man/intel_gpu_frequency.man         | 58 ---------------------------
 man/intel_gpu_frequency.rst         | 79 +++++++++++++++++++++++++++++++++++++
 man/intel_gpu_top.man               | 41 -------------------
 man/intel_gpu_top.rst               | 64 ++++++++++++++++++++++++++++++
 man/intel_gtt.man                   | 14 -------
 man/intel_gtt.rst                   | 32 +++++++++++++++
 man/intel_infoframes.man            | 26 ------------
 man/intel_infoframes.rst            | 51 ++++++++++++++++++++++++
 man/intel_lid.man                   | 12 ------
 man/intel_lid.rst                   | 31 +++++++++++++++
 man/intel_panel_fitter.man          | 50 -----------------------
 man/intel_panel_fitter.rst          | 77 ++++++++++++++++++++++++++++++++++++
 man/intel_stepping.man              | 15 -------
 man/intel_stepping.rst              | 37 +++++++++++++++++
 man/intel_upload_blit_large.man     | 18 ---------
 man/intel_upload_blit_large.rst     | 34 ++++++++++++++++
 man/intel_upload_blit_large_gtt.man | 18 ---------
 man/intel_upload_blit_large_gtt.rst | 34 ++++++++++++++++
 man/intel_upload_blit_large_map.man | 18 ---------
 man/intel_upload_blit_large_map.rst | 34 ++++++++++++++++
 man/intel_upload_blit_small.man     | 18 ---------
 man/intel_upload_blit_small.rst     | 34 ++++++++++++++++
 33 files changed, 733 insertions(+), 418 deletions(-)
 delete mode 100644 man/intel_aubdump.man
 create mode 100644 man/intel_aubdump.rst
 delete mode 100644 man/intel_audio_dump.man
 create mode 100644 man/intel_audio_dump.rst
 delete mode 100644 man/intel_bios_dumper.man
 create mode 100644 man/intel_bios_dumper.rst
 delete mode 100644 man/intel_bios_reader.man
 create mode 100644 man/intel_bios_reader.rst
 delete mode 100644 man/intel_error_decode.man
 create mode 100644 man/intel_error_decode.rst
 delete mode 100644 man/intel_gpu_frequency.man
 create mode 100644 man/intel_gpu_frequency.rst
 delete mode 100644 man/intel_gpu_top.man
 create mode 100644 man/intel_gpu_top.rst
 delete mode 100644 man/intel_gtt.man
 create mode 100644 man/intel_gtt.rst
 delete mode 100644 man/intel_infoframes.man
 create mode 100644 man/intel_infoframes.rst
 delete mode 100644 man/intel_lid.man
 create mode 100644 man/intel_lid.rst
 delete mode 100644 man/intel_panel_fitter.man
 create mode 100644 man/intel_panel_fitter.rst
 delete mode 100644 man/intel_stepping.man
 create mode 100644 man/intel_stepping.rst
 delete mode 100644 man/intel_upload_blit_large.man
 create mode 100644 man/intel_upload_blit_large.rst
 delete mode 100644 man/intel_upload_blit_large_gtt.man
 create mode 100644 man/intel_upload_blit_large_gtt.rst
 delete mode 100644 man/intel_upload_blit_large_map.man
 create mode 100644 man/intel_upload_blit_large_map.rst
 delete mode 100644 man/intel_upload_blit_small.man
 create mode 100644 man/intel_upload_blit_small.rst
man/Makefile.am +30 -32
index 69742403d69e..e40e2e931ada 100644
@@ -1,41 +1,39 @@
 appmandir = $(APP_MAN_DIR)
-appman_PRE = 				\
-	intel_aubdump.man		\
-	intel_audio_dump.man		\
-	intel_bios_dumper.man		\
-	intel_bios_reader.man		\
-	intel_error_decode.man		\
-	intel_gpu_frequency.man		\
-	intel_gpu_top.man		\
-	intel_gtt.man			\
-	intel_infoframes.man		\
-	intel_lid.man			\
-	intel_panel_fitter.man		\
-	intel_stepping.man		\
-	intel_upload_blit_large.man	\
-	intel_upload_blit_large_gtt.man \
-	intel_upload_blit_large_map.man \
-	intel_upload_blit_small.man
-
-appman_DATA = $(appman_PRE:man=$(APP_MAN_SUFFIX))
-
-# man pages in rst, only used if we have rst2man
-appman_RST =				\
-	intel_reg.rst
+appman_RST = 				\
+	intel_aubdump.rst		\
+	intel_audio_dump.rst		\
+	intel_bios_dumper.rst		\
+	intel_bios_reader.rst		\
+	intel_error_decode.rst		\
+	intel_gpu_frequency.rst		\
+	intel_gpu_top.rst		\
+	intel_gtt.rst			\
+	intel_infoframes.rst		\
+	intel_lid.rst			\
+	intel_panel_fitter.rst		\
+	intel_reg.rst			\
+	intel_stepping.rst		\
+	intel_upload_blit_large.rst	\
+	intel_upload_blit_large_gtt.rst \
+	intel_upload_blit_large_map.rst \
+	intel_upload_blit_small.rst
 
 if HAVE_RST2MAN
-appman_DATA += $(appman_RST:rst=$(APP_MAN_SUFFIX))
+appman_DATA = $(appman_RST:rst=$(APP_MAN_SUFFIX))
 endif
 
-EXTRA_DIST = $(appman_PRE) $(appman_RST)
-CLEANFILES = $(appman_DATA)
+EXTRA_DIST = $(appman_RST)
+CLEANFILES = $(appman_DATA) defs.rst
 
-# String replacements in MAN_SUBSTS now come from xorg-macros.m4 via configure
-SUFFIXES = .$(APP_MAN_SUFFIX) .man
+SUFFIXES = .$(APP_MAN_SUFFIX)
 
-.man.$(APP_MAN_SUFFIX):
-	$(AM_V_GEN)$(SED) $(MAN_SUBSTS) < $< > $@
+# create some definitions useful in the man page rst sources
+defs.rst:
+	$(AM_V_GEN)echo ".. |PACKAGE_NAME| replace:: $(PACKAGE_NAME)" > $@
+	$(AM_V_GEN)echo ".. |PACKAGE_VERSION| replace:: $(PACKAGE_VERSION)" >> $@
+	$(AM_V_GEN)echo ".. |PACKAGE_STRING| replace:: $(PACKAGE_STRING)" >> $@
+	$(AM_V_GEN)echo ".. |MANUAL_SECTION| replace:: 1" >> $@
+	$(AM_V_GEN)echo ".. |MANUAL_GROUP| replace:: General Commands Manual" >> $@
 
-# FIXME: handle MAN_SUBST in rst
-.rst.$(APP_MAN_SUFFIX):
+%.$(APP_MAN_SUFFIX): %.rst defs.rst
 	$(AM_V_GEN)rst2man < $< > $@
man/intel_aubdump.man deleted +0 -38
deleted file mode 100644
index a77947e7f38e..000000000000
@@ -1,38 +0,0 @@
-.\" shorthand for double quote that works everywhere.
-.ds q \N'34'
-.TH intel_aubdump __appmansuffix__ __xorgversion__
-.SH NAME
-intel_aubdump \- Launch an application and capture rendering to an AUB file
-.SH SYNOPSIS
-.B intel_aubdump [\fIOPTION\fR]... \fI--\fR \fICOMMAND\fR [\fIARGUMENTS\fR]
-.SH DESCRIPTION
-.PP
-Run
-.IR COMMAND
-with
-.IR ARGUMENTS
-and dump an AUB file that captures buffer
-contents and execution of the i915 GEM application.
-.TP
-.B \-v
-Enable verbose mode.
-.TP
-.B \-\^\-help
-Output a usage message and exit.
-.TP
-.BI \-o " FILE" "\fR,\fP \-\^\-output=" FILE
-Write the trace output to the file
-.IR FILE .
-Default is 
-.IR COMMAND .aub.
-.TP
-.BI \-\^\-device= ID
-Override the PCI ID of the drm device. This is useful for getting an
-aub dump for a different generation of GPU. In this mode intel_aubdump
-will intercept but not forward the execbuffer2 ioctl, as that would
-typically cause a GPU hang.
-.SH EXAMPLES
-.TP
-intel_aubdump -v --output=stuff.aub -- glxgears -geometry 500x500
-Launches glxgears with its -geometry option and enables aub dumping
-with the -v and --output=stuff.aub options.
man/intel_aubdump.rst new file +55 -0

55 lines not on this page · raw message

man/intel_audio_dump.man deleted +0 -11
deleted file mode 100644
index 89a81ec456b2..000000000000
@@ -1,11 +0,0 @@
-.\" shorthand for double quote that works everywhere.
-.ds q \N'34'
-.TH intel_audio_dump __appmansuffix__ __xorgversion__
-.SH NAME
-intel_audio_dump \- Dumps the Intel GPU registers for HDMI audio setup.
-.SH SYNOPSIS
-.B intel_audio_dump
-.SH DESCRIPTION
-.B intel_audio_dump
-dumps and decodes registers containing the configuration of HDMI audio
-handling on Intel GPUs.
man/intel_audio_dump.rst new file +30 -0
new file mode 100644
index 000000000000..78bbae4422ff
@@ -0,0 +1,30 @@
+================
+intel_audio_dump
+================
+
+-------------------------------------------------
+Dump the Intel GPU registers for HDMI audio setup
+-------------------------------------------------
+.. include:: defs.rst
+:Author: Intel Graphics for Linux <[email protected]>
+:Date: 2016-03-01
+:Version: |PACKAGE_STRING|
+:Copyright: 2010,2012,2016 Intel Corporation
+:Manual section: |MANUAL_SECTION|
+:Manual group: |MANUAL_GROUP|
+
+SYNOPSIS
+========
+
+**intel_audio_dump**
+
+DESCRIPTION
+===========
+
+**intel_audio_dump** dumps and decodes registers containing the configuration of
+HDMI audio handling on Intel GPUs.
+
+REPORTING BUGS
+==============
+
+Report bugs to https://bugs.freedesktop.org.
man/intel_bios_dumper.man deleted +0 -14
deleted file mode 100644
index c9acaa469f2c..000000000000
@@ -1,14 +0,0 @@
-.\" shorthand for double quote that works everywhere.
-.ds q \N'34'
-.TH intel_bios_dumper __appmansuffix__ __xorgversion__
-.SH NAME
-intel_bios_dumper \- Saves the Intel video BIOS contents to a file.
-.SH SYNOPSIS
-.B intel_bios_dumper \fIfilename\fR
-.SH DESCRIPTION
-.B intel_bios_dumper
-is a tool to save the contents of the Intel video BIOS to a file.  It
-can then be parsed offline for debugging issues with the video bios
-table handling.
-.SH SEE ALSO
-.BR intel_bios_reader(1)
man/intel_bios_dumper.rst new file +36 -0
new file mode 100644
index 000000000000..89e0001a70f7
@@ -0,0 +1,36 @@
+=================
+intel_bios_dumper
+=================
+
+--------------------------------------------
+Save the Intel video BIOS contents to a file
+--------------------------------------------
+.. include:: defs.rst
+:Author: Intel Graphics for Linux <[email protected]>
+:Date: 2016-03-01
+:Version: |PACKAGE_STRING|
+:Copyright: 2010,2012,2016 Intel Corporation
+:Manual section: |MANUAL_SECTION|
+:Manual group: |MANUAL_GROUP|
+
+SYNOPSIS
+========
+
+**intel_bios_dumper** *FILENAME*
+
+DESCRIPTION
+===========
+
+**intel_bios_dumper** is a tool to save the contents of the Intel video BIOS to
+a file. It can then be parsed offline for debugging issues with the video bios
+table handling.
+
+REPORTING BUGS
+==============
+
+Report bugs to https://bugs.freedesktop.org.
+
+SEE ALSO
+========
+
+**intel_bios_reader(1)**
man/intel_bios_reader.man deleted +0 -15
deleted file mode 100644
index 2f125fc91c9c..000000000000
@@ -1,15 +0,0 @@
-.\" shorthand for double quote that works everywhere.
-.ds q \N'34'
-.TH intel_bios_reader __appmansuffix__ __xorgversion__
-.SH NAME
-intel_bios_reader \- Parses an Intel BIOS and displays many of its tables
-.SH SYNOPSIS
-.B intel_bios_reader \fIfilename\fR
-.SH DESCRIPTION
-.B intel_bios_reader
-is a tool to parse the contents of an Intel video BIOS file.  The file
-can come from intel_bios_dumper.  This can be used for quick debugging
-of video bios table handling, which is harder when done inside of the
-kernel graphics driver.
-.SH SEE ALSO
-.BR intel_bios_dumper (1)
man/intel_bios_reader.rst new file +37 -0
new file mode 100644
index 000000000000..7024f4ded226
@@ -0,0 +1,37 @@
+=================
+intel_bios_reader
+=================
+
+--------------------------------------------------
+Parse an Intel BIOS and display many of its tables
+--------------------------------------------------
+.. include:: defs.rst
+:Author: Intel Graphics for Linux <[email protected]>
+:Date: 2016-03-01
+:Version: |PACKAGE_STRING|
+:Copyright: 2010,2012,2016 Intel Corporation
+:Manual section: |MANUAL_SECTION|
+:Manual group: |MANUAL_GROUP|
+
+SYNOPSIS
+========
+
+**intel_bios_reader** *FILENAME*
+
+DESCRIPTION
+===========
+
+**intel_bios_reader** is a tool to parse the contents of an Intel video BIOS
+file. The file can come from **intel_bios_dumper(1)**. This can be used for
+quick debugging of video bios table handling, which is harder when done inside
+of the kernel graphics driver.
+
+REPORTING BUGS
+==============
+
+Report bugs to https://bugs.freedesktop.org.
+
+SEE ALSO
+========
+
+**intel_bios_dumper(1)**
man/intel_error_decode.man deleted +0 -20
deleted file mode 100644
index e53d898d58b2..000000000000
@@ -1,20 +0,0 @@
-.\" shorthand for double quote that works everywhere.
-.ds q \N'34'
-.TH intel_error_decode __appmansuffix__ __xorgversion__
-.SH NAME
-intel_error_decode \- Decodes an Intel GPU dump automatically captured by the kernel at the time of an error.
-.SH SYNOPSIS
-.nf
-.B intel_error_decode
-.B intel_error_decode [ filename ]
-.fi
-.SH DESCRIPTION
-.B intel_error_decode
-is a tool that decodes the instructions and state of the GPU at the time of
-an error. It requires kernel 2.6.34 or newer, and either debugfs mounted on
-/sys/kernel/debug or /debug containing a current i915_error_state or you can
-pass a file containing a saved error.
-.SS Options
-.TP
-.B filename
-Decodes a previously saved error.
man/intel_error_decode.rst new file +38 -0
new file mode 100644
index 000000000000..e7a54a6fe05b
@@ -0,0 +1,38 @@
+==================
+intel_error_decode
+==================
+
+-------------------------------------------------------------------------------------
+Decode an Intel GPU dump automatically captured by the kernel at the time of an error
+-------------------------------------------------------------------------------------
+.. include:: defs.rst
+:Author: Intel Graphics for Linux <[email protected]>
+:Date: 2016-03-01
+:Version: |PACKAGE_STRING|
+:Copyright: 2010,2012,2016 Intel Corporation
+:Manual section: |MANUAL_SECTION|
+:Manual group: |MANUAL_GROUP|
+
+SYNOPSIS
+========
+
+**intel_error_decode** [*FILENAME*]
+
+DESCRIPTION
+===========
+
+**intel_error_decode** is a tool that decodes the instructions and state of the
+GPU at the time of an error. It requires kernel 2.6.34 or newer, and either
+debugfs mounted on /sys/kernel/debug or /debug containing a current
+i915_error_state or you can pass a file containing a saved error.
+
+ARGUMENTS
+=========
+
+FILENAME
+    Decodes a previously saved error.
+
+REPORTING BUGS
+==============
+
+Report bugs to https://bugs.freedesktop.org.
man/intel_gpu_frequency.man deleted +0 -58

58 lines not on this page · raw message

man/intel_gpu_frequency.rst new file +79 -0

79 lines not on this page · raw message

man/intel_gpu_top.man deleted +0 -41

41 lines not on this page · raw message

man/intel_gpu_top.rst new file +64 -0

64 lines not on this page · raw message

man/intel_gtt.man deleted +0 -14
deleted file mode 100644
index 8b23f28734b0..000000000000
@@ -1,14 +0,0 @@
-.\" shorthand for double quote that works everywhere.
-.ds q \N'34'
-.TH intel_gtt __appmansuffix__ __xorgversion__
-.SH NAME
-intel_gtt \- Dump the contents of an Intel GPU's GTT
-.SH SYNOPSIS
-.B intel_gtt
-.SH DESCRIPTION
-.B intel_gtt
-is a tool to view the contents of the GTT on an Intel GPU.  The GTT is
-the page table that maps between GPU addresses and system memory.
-This tool can be useful in debugging the Linux AGP driver
-initialization of the chip or in debugging later overwriting of the
-GTT with garbage data.
man/intel_gtt.rst new file +32 -0
new file mode 100644
index 000000000000..d14184fa565e
@@ -0,0 +1,32 @@
+=========
+intel_gtt
+=========
+
+---------------------------------------
+Dump the contents of an Intel GPU's GTT
+---------------------------------------
+.. include:: defs.rst
+:Author: Intel Graphics for Linux <[email protected]>
+:Date: 2016-03-01
+:Version: |PACKAGE_STRING|
+:Copyright: 2010,2012,2016 Intel Corporation
+:Manual section: |MANUAL_SECTION|
+:Manual group: |MANUAL_GROUP|
+
+SYNOPSIS
+========
+
+**intel_gtt**
+
+DESCRIPTION
+===========
+
+**intel_gtt** is a tool to view the contents of the GTT on an Intel GPU. The GTT
+is the page table that maps between GPU addresses and system memory. This tool
+can be useful in debugging the Linux AGP driver initialization of the chip or in
+debugging later overwriting of the GTT with garbage data.
+
+REPORTING BUGS
+==============
+
+Report bugs to https://bugs.freedesktop.org.
man/intel_infoframes.man deleted +0 -26
deleted file mode 100644
index b015949280ab..000000000000
@@ -1,26 +0,0 @@
-.\" shorthand for double quote that works everywhere.
-.ds q \N'34'
-.TH intel_infoframes __appmansuffix__ __xorgversion__
-.SH NAME
-intel_infoframes \- View and change HDMI InfoFrames
-.SH SYNOPSIS
-.B intel_infoframes
-.SH DESCRIPTION
-.B intel_infoframes
-is a tool to view and change the HDMI InfoFrames sent by the GPU. Its main
-purpose is to be used as a debugging tool. In some cases (e.g., when
-changing modes) the Kernel will undo the changes made by this tool.
-
-Descriptions of the InfoFrame fields can be found on the HDMI and CEA-861
-specifications.
-
-Use the
-.B -h
-or
-.B --help
-options to learn how to use the command
-.SH LIMITATIONS
-Not all HDMI monitors respect the InfoFrames sent to them. Only GEN 4
-or newer hardware is supported yet.
-.SH SEE ALSO
-HDMI specification, CEA-861 specification.
man/intel_infoframes.rst new file +51 -0

51 lines not on this page · raw message

man/intel_lid.man deleted +0 -12
deleted file mode 100644
index fd554e8d64fa..000000000000
@@ -1,12 +0,0 @@
-.\" shorthand for double quote that works everywhere.
-.ds q \N'34'
-.TH intel_lid __appmansuffix__ __xorgversion__
-.SH NAME
-intel_lid \- Polls the values of different reports about laptop lid state.
-.SH SYNOPSIS
-.B intel_lid
-.SH DESCRIPTION
-.B intel_lid
-is a tool to poll ACPI and the BIOS scratch register's reporting of
-laptop lid state.  This can be used for debugging issues with laptop
-modesetting for lid opening and closing.
man/intel_lid.rst new file +31 -0
new file mode 100644
index 000000000000..8b7fd3fcfccb
@@ -0,0 +1,31 @@
+=========
+intel_lid
+=========
+
+-----------------------------------------------------------
+Poll the values of different reports about laptop lid state
+-----------------------------------------------------------
+.. include:: defs.rst
+:Author: Intel Graphics for Linux <[email protected]>
+:Date: 2016-03-01
+:Version: |PACKAGE_STRING|
+:Copyright: 2010,2012-2013,2016 Intel Corporation
+:Manual section: |MANUAL_SECTION|
+:Manual group: |MANUAL_GROUP|
+
+SYNOPSIS
+========
+
+**intel_lid**
+
+DESCRIPTION
+===========
+
+**intel_lid** is a tool to poll ACPI and the BIOS scratch register's reporting
+of laptop lid state. This can be used for debugging issues with laptop
+modesetting for lid opening and closing.
+
+REPORTING BUGS
+==============
+
+Report bugs to https://bugs.freedesktop.org.
man/intel_panel_fitter.man deleted +0 -50

50 lines not on this page · raw message

man/intel_panel_fitter.rst new file +77 -0

77 lines not on this page · raw message

man/intel_stepping.man deleted +0 -15
deleted file mode 100644
index fe17210707d5..000000000000
@@ -1,15 +0,0 @@
-.\" shorthand for double quote that works everywhere.
-.ds q \N'34'
-.TH intel_stepping __appmansuffix__ __xorgversion__
-.SH NAME
-intel_stepping \- Display the stepping information for an Intel GPU
-.SH SYNOPSIS
-.B intel_stepping
-.SH DESCRIPTION
-.B intel_stepping
-is a tool to print the stepping information for an Intel GPU, along with
-the PCI ID and revision used to determine it.
-It requires root privilege to map the graphics device.
-.SH BUGS
-Not all the known stepping IDs or chipsets are included, so the output
-on some devices may not be as specific as possible.
man/intel_stepping.rst new file +37 -0
new file mode 100644
index 000000000000..9ea7c1982866
@@ -0,0 +1,37 @@
+==============
+intel_stepping
+==============
+
+-------------------------------------------------
+Display the stepping information for an Intel GPU
+-------------------------------------------------
+.. include:: defs.rst
+:Author: Intel Graphics for Linux <[email protected]>
+:Date: 2016-03-01
+:Version: |PACKAGE_STRING|
+:Copyright: 2009,2012,2016 Intel Corporation
+:Manual section: |MANUAL_SECTION|
+:Manual group: |MANUAL_GROUP|
+
+SYNOPSIS
+========
+
+**intel_stepping**
+
+DESCRIPTION
+===========
+
+**intel_stepping** is a tool to print the stepping information for an Intel GPU,
+along with the PCI ID and revision used to determine it. It requires root
+privilege to map the graphics device.
+
+BUGS
+====
+
+Not all the known stepping IDs or chipsets are included, so the output on some
+devices may not be as specific as possible.
+
+REPORTING BUGS
+==============
+
+Report bugs to https://bugs.freedesktop.org.
man/intel_upload_blit_large.man deleted +0 -18
deleted file mode 100644
index 9c75e1a1c51d..000000000000
@@ -1,18 +0,0 @@
-.\" shorthand for double quote that works everywhere.
-.ds q \N'34'
-.TH intel_upload_blit_large __appmansuffix__ __xorgversion__
-.SH NAME
-intel_upload_blit_large \- microbenchmark of Intel GPU performance
-.SH SYNOPSIS
-.nf
-.B intel_upload_blit_large
-.fi
-.SH DESCRIPTION
-.B intel_upload_blit_large
-is a microbenchmark tool for DRM performance.  It should be run with kernel
-modesetting enabled, and may require root privilege for correct operation.
-It does not require X to be running.
-.PP
-Given that it is a microbenchmark, its utility is largely for regression
-testing of the kernel, and not for general conclusions on graphics
-performance.
man/intel_upload_blit_large.rst new file +34 -0
new file mode 100644
index 000000000000..dc06d7016c40
@@ -0,0 +1,34 @@
+=======================
+intel_upload_blit_large
+=======================
+
+---------------------------------------
+Microbenchmark of Intel GPU performance
+---------------------------------------
+.. include:: defs.rst
+:Author: Intel Graphics for Linux <[email protected]>
+:Date: 2016-03-01
+:Version: |PACKAGE_STRING|
+:Copyright: 2009,2012,2016 Intel Corporation
+:Manual section: |MANUAL_SECTION|
+:Manual group: |MANUAL_GROUP|
+
+SYNOPSIS
+========
+
+**intel_upload_blit_large**
+
+DESCRIPTION
+===========
+
+**intel_upload_blit_large** is a microbenchmark tool for DRM performance. It
+should be run with kernel modesetting enabled, and may require root privilege
+for correct operation. It does not require X to be running.
+
+Given that it is a microbenchmark, its utility is largely for regression testing
+of the kernel, and not for general conclusions on graphics performance.
+
+REPORTING BUGS
+==============
+
+Report bugs to https://bugs.freedesktop.org.
man/intel_upload_blit_large_gtt.man deleted +0 -18
deleted file mode 100644
index fbe4623cf5e5..000000000000
@@ -1,18 +0,0 @@
-.\" shorthand for double quote that works everywhere.
-.ds q \N'34'
-.TH intel_upload_blit_large_gtt __appmansuffix__ __xorgversion__
-.SH NAME
-intel_upload_blit_large_gtt \- microbenchmark of Intel GPU performance
-.SH SYNOPSIS
-.nf
-.B intel_upload_blit_large_gtt
-.fi
-.SH DESCRIPTION
-.B intel_upload_blit_large_gtt
-is a microbenchmark tool for DRM performance.  It should be run with kernel
-modesetting enabled, and may require root privilege for correct operation.
-It does not require X to be running.
-.PP
-Given that it is a microbenchmark, its utility is largely for regression
-testing of the kernel, and not for general conclusions on graphics
-performance.
man/intel_upload_blit_large_gtt.rst new file +34 -0
new file mode 100644
index 000000000000..331eb8ddde48
@@ -0,0 +1,34 @@
+===========================
+intel_upload_blit_large_gtt
+===========================
+
+---------------------------------------
+Microbenchmark of Intel GPU performance
+---------------------------------------
+.. include:: defs.rst
+:Author: Intel Graphics for Linux <[email protected]>
+:Date: 2016-03-01
+:Version: |PACKAGE_STRING|
+:Copyright: 2009,2012,2016 Intel Corporation
+:Manual section: |MANUAL_SECTION|
+:Manual group: |MANUAL_GROUP|
+
+SYNOPSIS
+========
+
+**intel_upload_blit_large_gtt**
+
+DESCRIPTION
+===========
+
+**intel_upload_blit_large_gtt** is a microbenchmark tool for DRM performance.
+It should be run with kernel modesetting enabled, and may require root privilege
+for correct operation. It does not require X to be running.
+
+Given that it is a microbenchmark, its utility is largely for regression testing
+of the kernel, and not for general conclusions on graphics performance.
+
+REPORTING BUGS
+==============
+
+Report bugs to https://bugs.freedesktop.org.
man/intel_upload_blit_large_map.man deleted +0 -18
deleted file mode 100644
index 04123f3dded5..000000000000
@@ -1,18 +0,0 @@
-.\" shorthand for double quote that works everywhere.
-.ds q \N'34'
-.TH intel_upload_blit_large_map __appmansuffix__ __xorgversion__
-.SH NAME
-intel_upload_blit_large_map \- microbenchmark of Intel GPU performance
-.SH SYNOPSIS
-.nf
-.B intel_upload_blit_large_map
-.fi
-.SH DESCRIPTION
-.B intel_upload_blit_large_map
-is a microbenchmark tool for DRM performance.  It should be run with kernel
-modesetting enabled, and may require root privilege for correct operation.
-It does not require X to be running.
-.PP
-Given that it is a microbenchmark, its utility is largely for regression
-testing of the kernel, and not for general conclusions on graphics
-performance.
man/intel_upload_blit_large_map.rst new file +34 -0
new file mode 100644
index 000000000000..32beb4149c70
@@ -0,0 +1,34 @@
+===========================
+intel_upload_blit_large_map
+===========================
+
+---------------------------------------
+Microbenchmark of Intel GPU performance
+---------------------------------------
+.. include:: defs.rst
+:Author: Intel Graphics for Linux <[email protected]>
+:Date: 2016-03-01
+:Version: |PACKAGE_STRING|
+:Copyright: 2009,2012,2016 Intel Corporation
+:Manual section: |MANUAL_SECTION|
+:Manual group: |MANUAL_GROUP|
+
+SYNOPSIS
+========
+
+**intel_upload_blit_large_map**
+
+DESCRIPTION
+===========
+
+**intel_upload_blit_large_map** is a microbenchmark tool for DRM performance.
+It should be run with kernel modesetting enabled, and may require root privilege
+for correct operation. It does not require X to be running.
+
+Given that it is a microbenchmark, its utility is largely for regression testing
+of the kernel, and not for general conclusions on graphics performance.
+
+REPORTING BUGS
+==============
+
+Report bugs to https://bugs.freedesktop.org.
man/intel_upload_blit_small.man deleted +0 -18
deleted file mode 100644
index 478bbfc5ced5..000000000000
@@ -1,18 +0,0 @@
-.\" shorthand for double quote that works everywhere.
-.ds q \N'34'
-.TH intel_upload_blit_small __appmansuffix__ __xorgversion__
-.SH NAME
-intel_upload_blit_small \- microbenchmark of Intel GPU performance
-.SH SYNOPSIS
-.nf
-.B intel_upload_blit_small
-.fi
-.SH DESCRIPTION
-.B intel_upload_blit_small
-is a microbenchmark tool for DRM performance.  It should be run with kernel
-modesetting enabled, and may require root privilege for correct operation.
-It does not require X to be running.
-.PP
-Given that it is a microbenchmark, its utility is largely for regression
-testing of the kernel, and not for general conclusions on graphics
-performance.
man/intel_upload_blit_small.rst new file +34 -0
new file mode 100644
index 000000000000..2a8d80de2bc1
@@ -0,0 +1,34 @@
+=======================
+intel_upload_blit_small
+=======================
+
+---------------------------------------
+Microbenchmark of Intel GPU performance
+---------------------------------------
+.. include:: defs.rst
+:Author: Intel Graphics for Linux <[email protected]>
+:Date: 2016-03-01
+:Version: |PACKAGE_STRING|
+:Copyright: 2009,2012,2016 Intel Corporation
+:Manual section: |MANUAL_SECTION|
+:Manual group: |MANUAL_GROUP|
+
+SYNOPSIS
+========
+
+**intel_upload_blit_small**
+
+DESCRIPTION
+===========
+
+**intel_upload_blit_small** is a microbenchmark tool for DRM performance. It
+should be run with kernel modesetting enabled, and may require root privilege
+for correct operation. It does not require X to be running.
+
+Given that it is a microbenchmark, its utility is largely for regression testing
+of the kernel, and not for general conclusions on graphics performance.
+
+REPORTING BUGS
+==============
+
+Report bugs to https://bugs.freedesktop.org.
Signature · 6 lines
2.1.4

_______________________________________________
Intel-gfx mailing list
[email protected]
https://lists.freedesktop.org/mailman/listinfo/intel-gfx
#1 lore raw

PATCH 2/2 man: update intel_reg.rst to be more in line with the others

Use the definitions and formatting used in other man pages, etc.

---
 man/intel_reg.rst | 106 ++++++++++++++++++++++--------------------------------
 1 file changed, 42 insertions(+), 64 deletions(-)
man/intel_reg.rst +42 -64
index d90c307d8379..d1af178ad1a0 100644
@@ -5,18 +5,18 @@ intel_reg
 ---------------------------------
 Intel graphics register multitool
 ---------------------------------
-
+.. include:: defs.rst
 :Author: Jani Nikula <[email protected]>
-:Date: 2015-04-14
-:Version: intel-gpu-tools
-:Copyright: 2015 Intel Corporation
-:Manual section: 1
-:Manual group: General Commands Manual
+:Date: 2016-03-01
+:Version: |PACKAGE_STRING|
+:Copyright: 2015-2016 Intel Corporation
+:Manual section: |MANUAL_SECTION|
+:Manual group: |MANUAL_GROUP|
 
 SYNOPSIS
 ========
 
-**intel_reg** [*option* ...] *command*
+**intel_reg** [*OPTIONS*] *COMMAND*
 
 DESCRIPTION
 ===========
@@ -30,50 +30,33 @@ OPTIONS
 Some options are global, and some specific to commands.
 
 --verbose
----------
-
-Increase verbosity.
+    Increase verbosity.
 
 --quiet
--------
-
-Decrease verbosity.
+    Decrease verbosity.
 
 --count=N
----------
-
-Read N registers.
+    Read N registers.
 
 --binary
---------
-
-Output binary values.
+    Output binary values.
 
 --all
------
-
-Decode registers for all known platforms.
+    Decode registers for all known platforms.
 
 --mmio=FILE
------------
-
-Use MMIO bar from FILE.
+    Use MMIO bar from FILE.
 
 --devid=DEVID
--------------
-
-Pretend to be PCI ID DEVID. Useful with MMIO bar snapshots from other machines.
+    Pretend to be PCI ID DEVID. Useful with MMIO bar snapshots from other
+    machines.
 
 --spec=PATH
------------
-
-Read register spec from directory or file specified by PATH; see REGISTER SPEC
-DEFINITIONS below for details.
+    Read register spec from directory or file specified by PATH; see REGISTER
+    SPEC DEFINITIONS below for details.
 
 --help
-------
-
-Show brief help.
+    Show brief help.
 
 COMMANDS
 ========
@@ -123,52 +106,42 @@ REGISTER REFERENCES
 Registers are defined as [(PORTNAME|PORTNUM|MMIO-OFFSET):](REGNAME|REGADDR).
 
 PORTNAME
---------
-
-The register access method, most often MMIO, which is the default. The methods
-supported on all platforms are "mmio", "portio-vga", and "mmio-vga".
+    The register access method, most often MMIO, which is the default. The
+    methods supported on all platforms are "mmio", "portio-vga", and "mmio-vga".
 
-On BYT and CHV, the sideband ports "bunit", "punit", "nc", "dpio", "gpio-nc",
-"cck", "ccu", "dpio2", and "flisdsi" are also supported.
+    On BYT and CHV, the sideband ports "bunit", "punit", "nc", "dpio",
+    "gpio-nc", "cck", "ccu", "dpio2", and "flisdsi" are also supported.
 
 PORTNUM
--------
+    Port number for the sideband ports supported on BYT and CHV. Only numbers
+    mapped to the supported ports are allowed, arbitrary numbers are not
+    accepted.
 
-Port number for the sideband ports supported on BYT and CHV. Only numbers mapped
-to the supported ports are allowed, arbitrary numbers are not accepted.
-
-Numbers above 0xff are automatically interpreted as MMIO offsets, not port
-numbers.
+    Numbers above 0xff are automatically interpreted as MMIO offsets, not port
+    numbers.
 
 MMIO-OFFSET
------------
-
-Use MMIO, and add this offset to the register address.
+    Use MMIO, and add this offset to the register address.
 
-Numbers equal to or below 0xff are automatically interpreted as port numbers,
-not MMIO offsets.
+    Numbers equal to or below 0xff are automatically interpreted as port
+    numbers, not MMIO offsets.
 
 REGNAME
--------
+    Name of the register as defined in the register spec.
 
-Name of the register as defined in the register spec.
-
-If MMIO offset is not specified, it is picked up from the register
-spec. However, ports are not; the port is a namespace for the register names.
+    If MMIO offset is not specified, it is picked up from the register
+    spec. However, ports are not; the port is a namespace for the register
+    names.
 
 REGADDR
--------
-
-Register address. The corresponding register name need not be specified in the
-register spec.
+    Register address. The corresponding register name need not be specified in
+    the register spec.
 
 ENVIRONMENT
 ===========
 
 INTEL_REG_SPEC
---------------
-
-Path to a directory or a file containing register spec definitions.
+    Path to a directory or a file containing register spec definitions.
 
 REGISTER SPEC DEFINITIONS
 =========================
@@ -226,3 +199,8 @@ BUGS
 ====
 
 Reading some registers may hang the GPU or the machine.
+
+REPORTING BUGS
+==============
+
+Report bugs to https://bugs.freedesktop.org.
Signature · 6 lines
2.1.4

_______________________________________________
Intel-gfx mailing list
[email protected]
https://lists.freedesktop.org/mailman/listinfo/intel-gfx
#2 lore raw
In reply to Jani Nikula
Quoted 2 lines · Jani Nikula

intel_reg.rst was the first man page written in reStructuredText. Follow suit with the rest of the man pages.

Marius, Daniel, any comments before I go ahead and push?

BR,
Jani.

Signature · 5 lines
Jani Nikula, Intel Open Source Technology Center
_______________________________________________
Intel-gfx mailing list
[email protected]
https://lists.freedesktop.org/mailman/listinfo/intel-gfx