From d01ebbd97ddb323564c75bfaaa374011fde4cd38 Mon Sep 17 00:00:00 2001 From: Thomas Wood Date: Mon, 29 Jun 2015 16:47:14 +0100 Subject: docs: various documentation fixes Signed-off-by: Thomas Wood --- docs/reference/intel-gpu-tools/igt_test_programs.xml | 10 +++++----- lib/igt_aux.c | 4 ++-- lib/igt_core.c | 4 ++-- lib/igt_core.h | 14 +++++++------- lib/igt_debugfs.c | 10 +++++----- lib/igt_fb.c | 8 ++++---- lib/igt_kms.c | 6 +++--- lib/intel_batchbuffer.c | 4 ++-- lib/intel_chipset.c | 2 +- lib/intel_iosf.c | 2 +- lib/intel_mmio.c | 2 +- lib/intel_os.c | 4 ++-- lib/ioctl_wrappers.c | 4 ++-- 13 files changed, 37 insertions(+), 37 deletions(-) diff --git a/docs/reference/intel-gpu-tools/igt_test_programs.xml b/docs/reference/intel-gpu-tools/igt_test_programs.xml index bf8a939d..97159df9 100644 --- a/docs/reference/intel-gpu-tools/igt_test_programs.xml +++ b/docs/reference/intel-gpu-tools/igt_test_programs.xml @@ -38,8 +38,8 @@ print extra debugging information when running tests and - optionaly only show the messages from the specified log domain - (use "application" to specifiy the default application domain) + optionally only show the messages from the specified log domain + (use "application" to specify the default application domain) @@ -74,7 +74,7 @@ #IGT_EXIT_SUCCESS 0 - The test was succesful + The test was successful #IGT_EXIT_SKIP @@ -191,7 +191,7 @@ - Gloassary + Glossary The following terms are commonly used in test names to describe various features of the test and can be used to filter and select @@ -249,7 +249,7 @@ rte - Runtime enviroment checks. + Runtime environment checks. diff --git a/lib/igt_aux.c b/lib/igt_aux.c index 8dfbe5bf..20e7c422 100644 --- a/lib/igt_aux.c +++ b/lib/igt_aux.c @@ -249,7 +249,7 @@ static void igt_interactive_info(const char *format, ...) * @total: total amount of work * * This function draws a progress indicator, which is useful for running - * long-winded tests manually on the console. To avoid spamming logfiles in + * long-winded tests manually on the console. To avoid spamming log files in * automated runs the progress indicator is suppressed when not running on a * terminal. */ @@ -469,7 +469,7 @@ void igt_debug_wait_for_keypress(const char *var) * When not connected to a terminal interactive_debug is ignored * and execution immediately continues. For this reason by default this function * returns true. It returns false only when N/n is pressed indicating the - * user ins't seeing what was expected. + * user isn't seeing what was expected. * * Force test fail when N/n is pressed. */ diff --git a/lib/igt_core.c b/lib/igt_core.c index fb6246cf..1a453d73 100644 --- a/lib/igt_core.c +++ b/lib/igt_core.c @@ -690,7 +690,7 @@ out: * @extra_opt_handler: handler for the additional options * @handler_data: user data given to @extra_opt_handler when invoked * - * This function handles the subtest related cmdline options and allows an + * This function handles the subtest related command line options and allows an * arbitrary set of additional options. This is useful for tests which have * additional knobs to tune when run manually like the number of rounds execute * or the size of the allocated buffer objects. @@ -1632,7 +1632,7 @@ void igt_skip_on_simulation(void) * This is the generic structured logging helper function. i-g-t testcase should * output all normal message to stdout. Warning level message should be printed * to stderr and the test runner should treat this as an intermediate result - * between SUCESS and FAILURE. + * between SUCCESS and FAILURE. * * The log level can be set through the IGT_LOG_LEVEL environment variable with * values "debug", "info", "warn", "critical" and "none". By default verbose diff --git a/lib/igt_core.h b/lib/igt_core.h index 2b2b6e93..babb0bb0 100644 --- a/lib/igt_core.h +++ b/lib/igt_core.h @@ -100,8 +100,8 @@ void __igt_fixture_end(void) __attribute__((noreturn)); * Annotate global test fixture code * * Testcase with subtests often need to set up a bunch of global state as the - * common test fixture. To avoid such code interferring with the subtest - * enumeration (e.g. when enumerating on systemes without an intel gpu) such + * common test fixture. To avoid such code interfering with the subtest + * enumeration (e.g. when enumerating on systems without an intel gpu) such * blocks should be annotated with igt_fixture. */ #define igt_fixture for (int igt_tokencat(__tmpint,__LINE__) = 0; \ @@ -131,7 +131,7 @@ int igt_subtest_init_parse_opts(int *argc, char **argv, * @argv: argv from the test's main() * * This initializes the for tests with subtests without the need for additional - * cmdline options. It is just a simplified version of + * command line options. It is just a simplified version of * igt_subtest_init_parse_opts(). * * If there's not a reason to the contrary it's less error prone to just use an @@ -199,7 +199,7 @@ bool igt_only_list_subtests(void); * * This is a magic control flow block used instead of a main() function for * tests with subtests. Open-coding the main() function is only recommended if - * the test needs to parse additional cmdline arguments of its own. + * the test needs to parse additional command line arguments of its own. */ #define igt_main \ static void igt_tokencat(__real_main, __LINE__)(void); \ @@ -239,7 +239,7 @@ void igt_simple_init_parse_opts(int *argc, char **argv, * * This is a magic control flow block used instead of a main() function for * simple tests. Open-coding the main() function is only recommended if - * the test needs to parse additional cmdline arguments of its own. + * the test needs to parse additional command line arguments of its own. */ #define igt_simple_main \ static void igt_tokencat(__real_main, __LINE__)(void); \ @@ -353,7 +353,7 @@ void igt_exit(void) __attribute__((noreturn)); * @ncmp: negated version of @cmp * @n2: second value * - * Like igt_assert_cmpint(), but for unsigned ints; + * Like igt_assert_cmpint(), but for unsigned ints. */ #define igt_assert_cmpuint(n1, cmp, ncmp, n2) \ do { \ @@ -371,7 +371,7 @@ void igt_exit(void) __attribute__((noreturn)); * @ncmp: negated version of @cmp * @n2: second value * - * Like igt_assert_cmpint(), but for doubles; + * Like igt_assert_cmpint(), but for doubles. */ #define igt_assert_cmpdouble(n1, cmp, ncmp, n2) \ do { \ diff --git a/lib/igt_debugfs.c b/lib/igt_debugfs.c index d4a48c54..a2c6fe29 100644 --- a/lib/igt_debugfs.c +++ b/lib/igt_debugfs.c @@ -71,11 +71,11 @@ * * This covers the miscellaneous debugfs interface wrappers: * - * - drm/i915 supports interfaces to evict certain clases of gem buffer objects, - * see igt_drop_caches_set(). + * - drm/i915 supports interfaces to evict certain classes of gem buffer + * objects, see igt_drop_caches_set(). * * - drm/i915 supports an interface to disable prefaulting, useful to test - * slowpaths in ioctls. See igt_disable_prefault(). + * slow paths in ioctls. See igt_disable_prefault(). */ /* @@ -143,7 +143,7 @@ static igt_debugfs_t *__igt_debugfs_singleton(void) * @mode: mode bits as used by open() * * This opens a debugfs file as a Unix file descriptor. The filename should be - * relative to the drm device's root, i.e without "drm/". + * relative to the drm device's root, i.e. without "drm/". * * Returns: * The Unix file descriptor for the debugfs file or -1 if that didn't work out. @@ -166,7 +166,7 @@ int igt_debugfs_open(const char *filename, int mode) * @mode: mode string as used by fopen() * * This opens a debugfs file as a libc FILE. The filename should be - * relative to the drm device's root, i.e without "drm/". + * relative to the drm device's root, i.e. without "drm/". * * Returns: * The libc FILE pointer for the debugfs file or NULL if that didn't work out. diff --git a/lib/igt_fb.c b/lib/igt_fb.c index 076f4168..134dbd25 100644 --- a/lib/igt_fb.c +++ b/lib/igt_fb.c @@ -41,7 +41,7 @@ * * This library contains helper functions for handling kms framebuffer objects * using #igt_fb structures to track all the metadata. igt_create_fb() creates - * a basic framebufffer and igt_remove_fb() cleans everything up again. + * a basic framebuffer and igt_remove_fb() cleans everything up again. * * It also supports drawing using the cairo library and provides some simplified * helper functions to easily draw test patterns. The main function to create a @@ -130,7 +130,7 @@ static int create_bo_for_fb(int fd, int width, int height, int bpp, * @w: width of the fill rectangle * @h: height of the fill rectangle * @r: red value to use as fill color - * @g: gree value to use as fill color + * @g: green value to use as fill color * @b: blue value to use as fill color * * This functions draws a solid rectangle with the given color using the drawing @@ -152,7 +152,7 @@ void igt_paint_color(cairo_t *cr, int x, int y, int w, int h, * @w: width of the fill rectangle * @h: height of the fill rectangle * @r: red value to use as fill color - * @g: gree value to use as fill color + * @g: green value to use as fill color * @b: blue value to use as fill color * @a: alpha value to use as fill color * @@ -175,7 +175,7 @@ void igt_paint_color_alpha(cairo_t *cr, int x, int y, int w, int h, * @w: width of the fill rectangle * @h: height of the fill rectangle * @r: red value to use as fill color - * @g: gree value to use as fill color + * @g: green value to use as fill color * @b: blue value to use as fill color * * This functions draws a gradient into the rectangle which fades in from black diff --git a/lib/igt_kms.c b/lib/igt_kms.c index ffacef1f..203a3fbd 100644 --- a/lib/igt_kms.c +++ b/lib/igt_kms.c @@ -1719,12 +1719,12 @@ drmModeModeInfo *igt_output_get_mode(igt_output_t *output) /** * igt_output_override_mode: - * @output: Output of which the mode will be overriden + * @output: Output of which the mode will be overridden * @mode: New mode * * Overrides the output's mode with @mode, so that it is used instead of the * mode obtained with get connectors. Note that the mode is used without - * checking if the output supports it, so this might lead to unexpect results. + * checking if the output supports it, so this might lead to unexpected results. */ void igt_output_override_mode(igt_output_t *output, drmModeModeInfo *mode) { @@ -1804,7 +1804,7 @@ void igt_plane_set_position(igt_plane_t *plane, int x, int y) * @h: height * * This function sets width and height for requested plane. - * New size will be commited at plane commit time via + * New size will be committed at plane commit time via * drmModeSetPlane(). */ void igt_plane_set_size(igt_plane_t *plane, int w, int h) diff --git a/lib/intel_batchbuffer.c b/lib/intel_batchbuffer.c index a2e502f1..fc1550fd 100644 --- a/lib/intel_batchbuffer.c +++ b/lib/intel_batchbuffer.c @@ -439,7 +439,7 @@ intel_copy_bo(struct intel_batchbuffer *batch, * igt_buf_width: * @buf: the i-g-t buffer object * - * Computes the widht in 32-bit pixels of the given buffer. + * Computes the width in 32-bit pixels of the given buffer. * * Returns: * The width of the buffer. @@ -674,7 +674,7 @@ void igt_blitter_fast_copy__raw(int fd, * @dst_x: destination pixel x-coordination * @dst_y: destination pixel y-coordination * - * Copy @src into @dst using the gen9 fast copy blitter comamnd. + * Copy @src into @dst using the gen9 fast copy blitter command. * * The source and destination surfaces cannot overlap. */ diff --git a/lib/intel_chipset.c b/lib/intel_chipset.c index c0926287..7ac2d1f0 100644 --- a/lib/intel_chipset.c +++ b/lib/intel_chipset.c @@ -173,7 +173,7 @@ int intel_gen(uint32_t devid) * intel_check_pch: * * Detects the PCH chipset type of the running systems and fills in the results - * into the global #intel_pch varaible. + * into the global #intel_pch variable. */ void intel_check_pch(void) diff --git a/lib/intel_iosf.c b/lib/intel_iosf.c index df1cdc0c..3b5a1370 100644 --- a/lib/intel_iosf.c +++ b/lib/intel_iosf.c @@ -66,7 +66,7 @@ static int vlv_sideband_rw(uint32_t port, uint8_t opcode, uint32_t addr, /** * intel_punit_read: * @addr: register offset - * @val: pointer to starge for the read result + * @val: pointer to store the read result * * 32-bit read of the register at @offset through the P-Unit sideband port. * diff --git a/lib/intel_mmio.c b/lib/intel_mmio.c index e6dd493f..e5e23c3d 100644 --- a/lib/intel_mmio.c +++ b/lib/intel_mmio.c @@ -153,7 +153,7 @@ release_forcewake_lock(int fd) /** * intel_register_access_init: - * @pci_dev: intel gracphis pci device + * @pci_dev: intel graphics pci device * @safe: use safe register access tables * * This initializes the new register access library, which supports forcewake diff --git a/lib/intel_os.c b/lib/intel_os.c index 3321a8de..f570d2c4 100644 --- a/lib/intel_os.c +++ b/lib/intel_os.c @@ -196,7 +196,7 @@ intel_get_total_swap_mb(void) * intel_require_memory: * @count: number of surfaces that will be created * @size: the size in bytes of each surface - * @mode: a bitfield declaring whether the test will be run in RAM or in SWAP + * @mode: a bit field declaring whether the test will be run in RAM or in SWAP * * Computes the total amount of memory required to allocate @count surfaces, * each of @size bytes, and includes an estimate for kernel overhead. It then @@ -210,7 +210,7 @@ intel_get_total_swap_mb(void) * there is not enough RAM + SWAP! * * If there is not enough RAM this function calls igt_skip with an appropriate - * message. It only ever returns if the requirement is fullfilled. This function + * message. It only ever returns if the requirement is fulfilled. This function * also causes the test to be skipped automatically on simulation under the * assumption that any test that needs to check for memory requirements is a * thrashing test unsuitable for slow simulated systems. diff --git a/lib/ioctl_wrappers.c b/lib/ioctl_wrappers.c index a269d0fd..53bd635d 100644 --- a/lib/ioctl_wrappers.c +++ b/lib/ioctl_wrappers.c @@ -526,7 +526,7 @@ bool gem_mmap__has_wc(int fd) * gem_mmap__wc: * @fd: open i915 drm file descriptor * @handle: gem buffer object handle - * @offset: offset in the gem buffer of te mmap arena + * @offset: offset in the gem buffer of the mmap arena * @size: size of the mmap arena * @prot: memory protection bits as used by mmap() * @@ -562,7 +562,7 @@ void *gem_mmap__wc(int fd, uint32_t handle, uint64_t offset, uint64_t size, unsi * gem_mmap__cpu: * @fd: open i915 drm file descriptor * @handle: gem buffer object handle - * @offset: offset in the gem buffer of te mmap arena + * @offset: offset in the gem buffer of the mmap arena * @size: size of the mmap arena * @prot: memory protection bits as used by mmap() * -- cgit v1.2.3