docs: Update documentation generation with missing entries
PATCH 1/1 docs: Update documentation generation with missing entries
This adds missing entries for documentation generation, both for tests and the API reference.
The list of tests is made complete and ordered alphabetically, with modified descriptions for consistency.
More files are added to the API reference, with a minimalistic description block added to them when it was missing.
--- docs/reference/intel-gpu-tools/Makefile.am | 24 +++- .../intel-gpu-tools/igt_test_programs.xml | 123 +++++++++++++++++---- .../intel-gpu-tools/intel-gpu-tools-docs.xml | 26 +++-- lib/igt_gvt.c | 7 ++ lib/igt_primes.c | 7 ++ lib/igt_rand.c | 7 ++ lib/igt_x86.c | 7 ++ lib/sw_sync.c | 7 ++ 8 files changed, 174 insertions(+), 34 deletions(-)
docs/reference/intel-gpu-tools/Makefile.am +21 -3
@@ -134,7 +134,11 @@ IGNORE_HFILES=gen6_render.h gen7_media.h gen7_render.h gen8_media.h \ # e.g. HTML_IMAGES=$(top_srcdir)/gtk/stock-icons/stock_about_24.png HTML_IMAGES= -test_program_files = xml/igt_test_programs_core_description.xml \ +test_program_files = xml/igt_test_programs_amdgpu_description.xml \ + xml/igt_test_programs_amdgpu_programs.xml \ + xml/igt_test_programs_chamelium_description.xml \ + xml/igt_test_programs_chamelium_programs.xml \ + xml/igt_test_programs_core_description.xml \ xml/igt_test_programs_core_programs.xml \ xml/igt_test_programs_debugfs_description.xml \ xml/igt_test_programs_debugfs_programs.xml \
@@ -146,14 +150,28 @@ test_program_files = xml/igt_test_programs_core_description.xml \ xml/igt_test_programs_gem_programs.xml \ xml/igt_test_programs_gen3_description.xml \ xml/igt_test_programs_gen3_programs.xml \ + xml/igt_test_programs_gen7_description.xml \ + xml/igt_test_programs_gen7_programs.xml \ + xml/igt_test_programs_gvt_description.xml \ + xml/igt_test_programs_gvt_programs.xml \ xml/igt_test_programs_kms_description.xml \ xml/igt_test_programs_kms_programs.xml \ + xml/igt_test_programs_meta_description.xml \ + xml/igt_test_programs_meta_programs.xml \ + xml/igt_test_programs_perf_description.xml \ + xml/igt_test_programs_perf_programs.xml \ xml/igt_test_programs_pm_description.xml \ xml/igt_test_programs_pm_programs.xml \ xml/igt_test_programs_prime_description.xml \ xml/igt_test_programs_prime_programs.xml \ - xml/igt_test_programs_sysfs_description.xml \ - xml/igt_test_programs_sysfs_programs.xml \ + xml/igt_test_programs_sw_sync_description.xml \ + xml/igt_test_programs_sw_sync_programs.xml \ + xml/igt_test_programs_testdisplay_description.xml \ + xml/igt_test_programs_testdisplay_programs.xml \ + xml/igt_test_programs_tools_description.xml \ + xml/igt_test_programs_tools_programs.xml \ + xml/igt_test_programs_vgem_description.xml \ + xml/igt_test_programs_vgem_programs.xml \ $(NULL) # Extra SGML files that are included by $(DOC_MAIN_SGML_FILE).
docs/reference/intel-gpu-tools/igt_test_programs.xml +102 -21
186 lines not on this page · raw message
docs/reference/intel-gpu-tools/intel-gpu-tools-docs.xml +16 -10
@@ -16,25 +16,31 @@ <chapter> <title>API Reference</title> <xi:include href="xml/drmtest.xml"/> + <xi:include href="xml/igt_aux.xml"/> + <xi:include href="xml/igt_chamelium.xml"/> <xi:include href="xml/igt_core.xml"/> - <xi:include href="xml/igt_stats.xml"/> <xi:include href="xml/igt_debugfs.xml"/> - <xi:include href="xml/igt_sysfs.xml"/> <xi:include href="xml/igt_draw.xml"/> - <xi:include href="xml/igt_kms.xml"/> - <xi:include href="xml/igt_kmod.xml"/> + <xi:include href="xml/igt_dummyload.xml"/> <xi:include href="xml/igt_fb.xml"/> - <xi:include href="xml/igt_aux.xml"/> + <xi:include href="xml/igt_frame.xml"/> <xi:include href="xml/igt_gt.xml"/> + <xi:include href="xml/igt_gvt.xml"/> + <xi:include href="xml/igt_kmod.xml"/> + <xi:include href="xml/igt_kms.xml"/> <xi:include href="xml/igt_pm.xml"/> - <xi:include href="xml/ioctl_wrappers.xml"/> + <xi:include href="xml/igt_primes.xml"/> + <xi:include href="xml/igt_rand.xml"/> + <xi:include href="xml/igt_stats.xml"/> + <xi:include href="xml/igt_sysfs.xml"/> + <xi:include href="xml/igt_vc4.xml"/> + <xi:include href="xml/igt_vgem.xml"/> + <xi:include href="xml/igt_x86.xml"/> <xi:include href="xml/intel_batchbuffer.xml"/> <xi:include href="xml/intel_chipset.xml"/> <xi:include href="xml/intel_io.xml"/> - <xi:include href="xml/igt_vc4.xml"/> - <xi:include href="xml/igt_vgem.xml"/> - <xi:include href="xml/igt_dummyload.xml"/> - <xi:include href="xml/igt_chamelium.xml"/> + <xi:include href="xml/ioctl_wrappers.xml"/> + <xi:include href="xml/sw_sync.xml"/> </chapter> <xi:include href="xml/igt_test_programs.xml"/>
lib/igt_gvt.c +7 -0
@@ -31,6 +31,13 @@#include <unistd.h> #include <fcntl.h> +/** +* SECTION:igt_gvt +* @short_description: Graphics virtualization technology library +* @title: GVT +* @include: igt_gvt.h +*/ +static bool is_gvt_enabled (void ) {bool enabled = false;
lib/igt_primes.c +7 -0
@@ -28,6 +28,13 @@#include <string.h> #include <math.h> +/** +* SECTION:igt_primes +* @short_description: Prime numbers helper library +* @title: Primes +* @include: igt_primes.h +*/ +#define BITS_PER_CHAR 8#define BITS_PER_LONG (sizeof(long)*BITS_PER_CHAR)
lib/igt_rand.c +7 -0
@@ -1,5 +1,12 @@#include "igt_rand.h" +/** +* SECTION:igt_rand +* @short_description: Random numbers helper library +* @title: Random +* @include: igt_rand.h +*/ +static uint32_t global =0x12345678 ;uint32_t hars_petruska_f54_1_random_seed (uint32_t new_state)
lib/igt_x86.c +7 -0
@@ -40,6 +40,13 @@#include "igt_x86.h" #include <stdio.h> +/** +* SECTION:igt_x86 +* @short_description: x86 helper library +* @title: x86 +* @include: igt_x86.h +*/ +#define BASIC_CPUID 0x0#define EXTENDED_CPUID 0x80000000
lib/sw_sync.c +7 -0
@@ -41,6 +41,13 @@#include "drmtest.h" #include "ioctl_wrappers.h" +/** +* SECTION:sw_sync +* @short_description: Software sync (fencing) support library +* @title: SW Sync +* @include: sw_sync.h +*/ +struct int_sync_create_fence_data {__u32 value;char name[32 ];
Signature · 6 lines
2.13.2 _______________________________________________ Intel-gfx mailing list [email protected] https://lists.freedesktop.org/mailman/listinfo/intel-gfx
Quoted 10 lines · Paul Kocialkowski
This adds missing entries for documentation generation, both for tests and the API reference.
The list of tests is made complete and ordered alphabetically, with modified descriptions for consistency.
More files are added to the API reference, with a minimalistic description block added to them when it was missing.
Signed-off-by Paul Kocialkowski <[email protected]>
pushed, thanks!
_______________________________________________
Intel-gfx mailing list
[email protected]
https://lists.freedesktop.org/mailman/listinfo/intel-gfx