Commit graph

29 commits

Author SHA1 Message Date
Emmanuele Bassi
3648bf24f6 build: Fix program listing syntax check
The modern gtk-doc syntax for program listing is `|[ ... ]|`.
2023-09-23 15:18:32 +01:00
Uli Schlachter
966bf2fe6a check-doc-syntax: Don't hardcode path to awk
Instead of expecting awk in /usr/bin, this commit changes the code to call awk
through a shell so that $PATH is searched.

Since this awk script shouldn't really be called manually, this is done by
removing the shebang from the awk script, marking it non-executable and fixing
up the caller.

Bugzilla: https://bugs.freedesktop.org/show_bug.cgi?id=67674
Reviewed-by: Bryce Harrington <b.harrington@samsung.com>
Signed-off-by: Uli Schlachter <psychon@znc.in>
2013-09-16 12:57:57 +02:00
Uli Schlachter
a184de9064 check-doc-syntax: Make this work again
Commit ed90616b77 changed the way the awk script gets invoked. Due to a
missing "test", this resulted in the awk script never getting invoked at all.

Signed-off-by: Uli Schlachter <psychon@znc.in>
2012-05-09 16:59:58 +02:00
Chris Wilson
ed90616b77 check-doc-syntax: Only parse the source files for incorrect tags
Signed-off-by: Chris Wilson <chris@chris-wilson.co.uk>
2012-04-29 19:29:12 +01:00
Chris Wilson
c16cdf0b4e check-doc-syntax: Fix handling of return value in make check 2012-04-29 19:29:12 +01:00
Andrea Canciani
71123cffe0 doc: Add script to enforce stricter validation of documentation comments 2012-03-29 11:03:18 +02:00
Benjamin Otte
8a1944f45b check: Allow unprefix type names in the title
Some documentation sections use the type name as the title, and we don't
want to use that title as a link.
2010-07-11 23:32:12 +02:00
Behdad Esfahbod
db4dbb3834 Improve doc syntax check to allow inline macro docs 2010-04-01 01:53:53 -04:00
Behdad Esfahbod
f433635240 Set LC_ALL=C instead of LANG=C 2009-09-16 15:50:34 -04:00
Chris Wilson
424aba9be5 [check] Search for the word NOTE
Add word boundary markers around the regexp so that we only match for the
word NOTE and not on substrings like GL_NOTEQUAL.
2008-11-29 10:14:26 +00:00
Chris Wilson
0d3e152d2f [check-doc-syntax.sh] Allow quoting.
func_regexp was incorrectly complaining that cairo_pure was a function without
parenthesis. The simplest solution appeared to be allow quoting of
'cairo_pure'.
2008-10-14 13:44:47 +01:00
Behdad Esfahbod
86e57671dd [check-*.sh] Redirect error reports to stderr 2008-09-26 11:08:22 -04:00
Behdad Esfahbod
1ee675d6a0 [src/check-doc/syntax.sh] Fix test for out-of-tree build
Now that our build system can compute a list of all cairo files,
we prefer to use that in the tests instead of running "find".
However, we were not switching to $(srcdir) so the test was not
finding source files in out-of-tree builds.  Noticed that from
the grep error in distcheck.
2008-09-18 15:56:34 -04:00
Behdad Esfahbod
5926257770 Revamp the build system.
Quick summary of changes:

  - Move list of cairo source files out of src/Makefile.am and into
    src/Sources.mk,

  - Generate files src/Config.mk and src/Config.mk.win32 that choose
    the right set of source files and headers based on configured
    backends and features.  This drastically simplifies building
    using other build systems.  The src/Makefile.win32 file needs
    to be updated to reflect these changes.

  - Add README files to various directories,

  - Add toplevel HACKING file.
2008-09-02 20:24:08 -04:00
Behdad Esfahbod
b9acf625d6 Make check-*.sh scripts more portable (#16299) 2008-06-12 21:03:19 -04:00
Behdad Esfahbod
0c208f2826 [src/check-doc-syntax.sh] Detect malformatted functions at line start 2008-06-01 19:13:49 -04:00
Behdad Esfahbod
b37c755730 [src/check-doc-syntax.sh] Detect malformatted enums starting the line 2008-06-01 18:46:23 -04:00
Behdad Esfahbod
5f63358018 [src/check-doc-syntax.sh] Fix some bugs in the check and fix errors found 2008-05-09 15:54:04 +02:00
Behdad Esfahbod
a3c091e292 [src/check-doc-syntax.sh] Use cairo_all_source_files if available 2008-05-09 14:54:31 +02:00
Chris Wilson
afa4ff8df5 [check] Filter programlistings for check-doc-syntax.sh
We do not want to enforce the gtk-doc markup in the preformated
examples, so run the files through sed to filter out <programlisting>
before checking with the error detecting regexp.
2008-04-29 10:02:51 +01:00
Carl Worth
5d9eefccd6 Disable enum_regexp test in check-doc-syntax.h
It's returning false positives on non-gtk-doc comments with non-public
enum values. Ick.
2008-03-20 15:37:04 -07:00
Carl Worth
2fee01e2d4 check-doc-syntax.sh: Fix for non-srcdir builds (such as make distcheck) 2008-01-30 04:54:39 -08:00
Nis Martensen
3d82056cee Fix typos 2008-01-29 05:32:24 -05:00
Behdad Esfahbod
b28f4f57f2 [src/Makefile.am] Reorganize
Main goal was to be able to pass list of all cairo sources, enabled or
not, to check-doc-syntax.sh such that it doesn't check *.h, *.c, *.cpp
because that can be annoying when bisecting.
2008-01-29 04:32:55 -05:00
Behdad Esfahbod
6153a3b620 [doc] Run check-doc-syntax.sh for SGML docs too 2008-01-29 00:43:10 -05:00
Behdad Esfahbod
3f7d301786 [src/check-doc-syntax.sh] Skip test if GNU grep is not available 2008-01-29 00:43:10 -05:00
Behdad Esfahbod
52cc603db1 [doc] Stricter syntax check for type names, update test 2008-01-28 22:10:20 -05:00
Behdad Esfahbod
b790c5a6bc [doc] Replace 'NOTE' by 'Note' and add it to test 2008-01-28 21:53:44 -05:00
Behdad Esfahbod
9ba8f6b1b0 [src/check-doc-syntax.sh] Check for various doc syntax consistency rules 2008-01-28 21:49:26 -05:00