Commit Graph

29904 Commits

Author SHA1 Message Date
Simon McVittie
66fda286e1 g-ir- tools: Add examples to man pages
Signed-off-by: Simon McVittie <smcv@collabora.com>
2024-02-14 12:07:46 +00:00
Simon McVittie
d0cb89538a Retitle gi-* man pages and update content
gi-compile-repository --module and gi-decompile-typelib --shlib are
intentionally undocumented here: they will be removed in !3926.

Signed-off-by: Simon McVittie <smcv@collabora.com>
2024-02-14 12:07:46 +00:00
Simon McVittie
615c51988d Spell Matthias' name correctly in the gi-* man pages
This was wrong since 2008.

Signed-off-by: Simon McVittie <smcv@collabora.com>
2024-02-14 12:07:46 +00:00
Simon McVittie
bca2ad0c03 Add metadata header to gi-* man pages
Signed-off-by: Simon McVittie <smcv@collabora.com>
2024-02-14 12:07:46 +00:00
Simon McVittie
30e8c6a1de Rename man pages to the tools' GLib names
Signed-off-by: Simon McVittie <smcv@collabora.com>
2024-02-14 12:07:46 +00:00
Simon McVittie
af9c0b0159 Remove generated man pages
Signed-off-by: Simon McVittie <smcv@collabora.com>
2024-02-14 12:07:46 +00:00
Simon McVittie
e37c94817d Move g-ir-compiler, g-ir-generate man pages to docs/reference/girepository
Signed-off-by: Simon McVittie <smcv@collabora.com>
2024-02-14 12:07:46 +00:00
Jan Tojnar
87ae4fb3ac docs: Update website link 2024-02-14 12:07:46 +00:00
Christoph Reiter
1bda59fcc9 Add a --version option to g-ir-compiler and g-ir-generate.
Resolves: gobject-introspection#55
2024-02-14 12:07:46 +00:00
Christoph Reiter
8d699b6268 Sphinx based user documentation
The current output (more or less a straight copy of the wiki) is available
here:

https://gi.readthedocs.io

This contains two changes:

* Converts all (not completely outdated) wiki pages to a sphinx based
  documentation.
* Converts the man pages to reST and adds a Makefile for building them
  using rst2man. So they can be easily exposed in the sphinx docs.

Goals:

* Have a user focused/compact documentation instead of random wiki pages
  with various todo/ideas pages.
* Take advantage of the gitlab MR workflow by
  * allowing large documentation changes/refactorings with reviews
  * allowing to combine features changes with documentation changes in MRs
2024-02-14 12:07:46 +00:00
Tomasz Miąsko
ae313e311d Update bug reporting links.
Also disable automatic hyphenation in manual pages to prevent wrapping
long URLs. Ensures that URLs can be easily navigated by clicking on
them.
2024-02-14 12:07:46 +00:00
Emmanuele Bassi
c7387b504a docs: Remove incorrect name rule
The leading `lib` should be passed as part of the shared library name in
the `--shared-library` argument for g-ir-compiler.

https://bugzilla.gnome.org/show_bug.cgi?id=699354
2024-02-14 12:07:46 +00:00
Ben Boeckel
e24c7f93c9 docs: fix manpage flag formats
Signed-off-by: Ben Boeckel <mathstuf@gmail.com>
2024-02-14 12:07:46 +00:00
Robert Roth
be0bb09c7a Fixed reference to obsolete name used in g-ir-generate manpage
https://bugzilla.gnome.org/show_bug.cgi?id=729901
2024-02-14 12:07:46 +00:00
Dieter Verfaillie
33b7bc36ad Update bugzilla product/component
g-i bug reports have been moved from:
  http://bugzilla.gnome.org/enter_bug.cgi?product=glib&amp;component=introspection
to:
  http://bugzilla.gnome.org/enter_bug.cgi?product=gobject-introspection

https://bugzilla.gnome.org/show_bug.cgi?id=745498
2024-02-14 12:07:46 +00:00
Dieter Verfaillie
0e11c0ad8d g-ir-compiler: remove references to --code, remove --no-init options
The "--code" option was removed years ago in ac81f3e8c5f1c380d16677232d67466e739da283
so remove references to it from README and g-ir-compiler(1)

Remove the "--no-init" option from g-ir-compiler and g-ir-compiler(1)
as it was documented to "can only be used if --code is also specified",
so no reason to keep it around.
2024-02-14 12:07:46 +00:00
Johan Dahlin
7bff894a04 Do not use triple dashes 2024-02-14 12:07:46 +00:00
Johan Dahlin
d500d23c58 Remove leading %
2008-09-06  Johan Dahlin  <johan@gnome.org>

    * docs/g-ir-generate.1: Remove leading %


svn path=/trunk/; revision=573
2024-02-14 12:07:45 +00:00
Johan Dahlin
3c65ea7a18 Add man pages for the generator and compiler.
2008-08-29  Johan Dahlin  <johan@gnome.org>

    * Makefile.am:
    * docs/g-ir-compiler.1:
    * docs/g-ir-generate.1:
    * docs/g-ir-scanner.1:
    Add man pages for the generator and compiler.


svn path=/trunk/; revision=518
2024-02-14 12:07:45 +00:00
Simon McVittie
64762fdef6 gi-decompile-typelib: Interpret --includedir as most-important-first
This is a behaviour change from g-ir-generate, which treats it as
least-important-first (the last directory on the command-line is
searched first).

gi-compile-repository --includedir and gcc -I are most-important-first
(the first directory on the command-line is searched first) so it seems
like it makes most sense to be consistent with that.

Signed-off-by: Simon McVittie <smcv@collabora.com>
2024-02-14 12:00:05 +00:00
Simon McVittie
f80e978f00 girwriter: Take the GIRepository as a parameter
We certainly won't find the requested namespace in a newly-created
repository with no typelibs loaded.

Fixes: 9ab84bc1 "girwriter: Stop using the singleton GIRepository"
Signed-off-by: Simon McVittie <smcv@collabora.com>
2024-02-14 11:13:04 +00:00
Yuri Chornoivan
b974fa4e50 Update Ukrainian translation 2024-02-14 11:00:38 +00:00
Ekaterine Papava
5d2ac37d5d Update Georgian translation 2024-02-14 09:30:19 +00:00
Philip Withnall
43924f7cf5 Merge branch 'fix-issue-3210' into 'main'
GWinHttpFile: Add support for G_FILE_ATTRIBUTE_STANDARD_TYPE

Closes #3210

See merge request GNOME/glib!3908
2024-02-14 09:22:36 +00:00
Luca Bacci
6ee0772146 GWinHttpFile: Add support for G_FILE_ATTRIBUTE_STANDARD_TYPE
Fixes #3210
2024-02-14 10:06:50 +01:00
Daniel Rusek
48e3fa1e17 Update Czech translation 2024-02-14 00:26:44 +00:00
Philip Withnall
3a2dea839b Merge branch 'wip/pwithnall/gutils-user-database-crash' into 'main'
ci: Fix printing the execution environment

See merge request GNOME/glib!3921
2024-02-13 23:44:56 +00:00
Yuri Chornoivan
4d120017e4 Update Ukrainian translation 2024-02-13 17:58:24 +00:00
Artur S0
8478898242 Update Russian translation 2024-02-13 16:38:19 +00:00
Philip Withnall
f3064e8a5c gutils: Make a variable const to avoid an unnecessary cast
And fix a typo in a comment. This introduces no functional changes.

Signed-off-by: Philip Withnall <pwithnall@gnome.org>
2024-02-13 15:22:04 +00:00
Philip Withnall
7420f9eccd ci: Fix printing the execution environment
Deriving from two templates means the `before_script` from the second
one overrides, rather than adding to, the one from the first.

Avoid that when using `.build-linux` and `.with-git` by explicitly
joining both scripts.

Signed-off-by: Philip Withnall <pwithnall@gnome.org>
2024-02-13 15:22:04 +00:00
Philip Withnall
060a7c2740 Merge branch 'wip/smcv/issue3252' into 'main'
gdatetime: Fix ja_JA.eucjp expectations when eras are unsupported

Closes #3252

See merge request GNOME/glib!3920
2024-02-13 13:31:29 +00:00
Emmanuele Bassi
7d6b2d7385 Merge branch 'wip/smcv/i386' into 'main'
girepository test: Don't assume doubles are naturally-aligned

See merge request GNOME/glib!3923
2024-02-13 12:27:07 +00:00
Philip Withnall
25c68a16e0 Merge branch 'wip/smcv/gdatetime-assertions' into 'main'
gdatetime test: Produce more helpful output on mismatches

See merge request GNOME/glib!3922
2024-02-13 11:57:00 +00:00
Simon McVittie
2b2b6de70b girepository test: Don't assume doubles are naturally-aligned
On i386 Linux, the minimal ABI alignment of a double is only 4, and
therefore the alignment of GDoubleIEEE754 is also 4.

Signed-off-by: Simon McVittie <smcv@collabora.com>
2024-02-13 11:33:54 +00:00
Philip Withnall
c250c7b925 Merge branch 'lint-no-valgrind' into 'main'
tests: Don’t run lint tests under valgrind

See merge request GNOME/glib!3918
2024-02-13 11:00:46 +00:00
Simon McVittie
9ceed6f0de gdatetime test: Produce more helpful output on mismatches
It's helpful for the assertion message to say what we were expecting and
what we actually got. It's also useful to have g_test_message()
diagnostics to indicate how far into the test we were.

Signed-off-by: Simon McVittie <smcv@collabora.com>
2024-02-13 10:39:49 +00:00
Simon McVittie
342d6176e7 gdatetime: Exercise %c, %C format placeholders in ja_JP.eucjp
Previously we didn't test these at all, which made it hard to determine
whether %Ec, %EC had appropriate output on platforms where era-based
dates are unsupported. Now we do, and we can observe that on platforms
with no support for era-based dates, %c matches %Ec and %C matches %EC,
as desired.

Signed-off-by: Simon McVittie <smcv@collabora.com>
2024-02-13 10:20:11 +00:00
Simon McVittie
988f4204a1 gdatetime: Fix ja_JA.eucjp expectations when eras are unsupported
I can't read Japanese, but these match the output of:

    env TZ=UTC LC_ALL=ja_JP.eucjp date -d2009-10-24T00:00:00Z '+%c' | iconv -f eucjp -t UTF-8
    env TZ=UTC LC_ALL=ja_JP.eucjp date -d2009-10-24T00:00:00Z '+%C' | iconv -f eucjp -t UTF-8

which seem like a reasonable thing to use as a reference.

According to Google Translate, 平成 refers to the Heisei era, which was
current during 2009, and seems unreasonable to expect as output on a
platform where era-based dates are unsupported.

Resolves: https://gitlab.gnome.org/GNOME/glib/-/issues/3252
Signed-off-by: Simon McVittie <smcv@collabora.com>
2024-02-13 10:20:02 +00:00
Philip Withnall
c0f5e6d217 Merge branch 'threadtests-performance' into 'main'
tests: Speed up threaded toggle notify test unless -m slow is passed

See merge request GNOME/glib!3919
2024-02-13 09:46:15 +00:00
Ekaterine Papava
4d7409334e Update Georgian translation 2024-02-13 09:45:09 +00:00
Philip Withnall
3c39a23a7e tests: Speed up threaded toggle notify test unless -m slow is passed
On a fast laptop, this test currently takes about 7s to run, which is a
significant portion of the overall test suite time.

On a slower CI machine, especially running the test under valgrind, the
test can time out.

There’s no need to always run so many iterations: we run the tests under
CI so often that it’s likely a failure will eventually be hit (if there
is a bug) even with fewer iterations. We also now run the tests once a
week with `-m slow`, so the original iteration count will also still be
used then.

Signed-off-by: Philip Withnall <pwithnall@gnome.org>
2024-02-13 08:52:15 +00:00
Philip Withnall
80e878005f tests: Don’t run lint tests under valgrind
That’s not useful, as the lint tests aren’t actually GLib code.

Signed-off-by: Philip Withnall <pwithnall@gnome.org>
2024-02-13 08:41:59 +00:00
Philip Withnall
342fa9c161
2.79.2
Signed-off-by: Philip Withnall <pwithnall@gnome.org>
2024-02-12 23:36:25 +00:00
Philip Withnall
6791878b97 Merge branch '3037-split-platform-docs' into 'main'
introspection: Generate separate GIR files and documentation for platform specific APIs

See merge request GNOME/glib!3892
2024-02-12 18:57:50 +00:00
Philip Withnall
19308d6c18 introspection: Re-add platform specific APIs to GLib-2.0.gir and Gio-2.0.gir
To avoid a big introspection API break.

These APIs are now listed in the new `{GLib,Gio}{Unix,Win32}-2.0.gir`
files, but for backwards compatibility they need to continue to be
listed in `Gio-2.0.gir` and `GLib-2.0.gir` as well, until the next major
introspection API break (and none is planned).

No new platform specific APIs should be added to these GIR files, but
these existing ones must remain.

See https://gitlab.gnome.org/GNOME/glib/-/merge_requests/3892#note_2001361

Signed-off-by: Philip Withnall <pwithnall@gnome.org>
2024-02-12 17:54:36 +00:00
Philip Withnall
4314944e56 introspection: Drop Unix and Win32 prefixes from platform specific APIs
So now introspection users will have to call `GLibUnix.open_pipe()`
rather than `GLibUnix.unix_open_pipe()` — or
`GLibWin32.check_windows_version()` rather than
`GLibWin32.win32_check_windows_version()`.

Signed-off-by: Philip Withnall <pwithnall@gnome.org>

Helps: #3037
2024-02-12 17:54:36 +00:00
Philip Withnall
2b4bfadfb7 tests: Remove an unnecessary include from test-common.h
It causes a build failure on mingw32, as `_WIN32_WINNT` is redefined.

Signed-off-by: Philip Withnall <pwithnall@gnome.org>
2024-02-12 17:54:36 +00:00
Philip Withnall
c428d6e673 ci: Build and tar the platform specific documentation
Enable the msys2-mingw32 CI job for merges, just like the fedora-x86_64
job is. The pair of them can then build the platform specific GIR and
documentation files.

The `download-reference.sh` script in the `docs-gtk-org` branch of GTK
can then download the docs as an artifact from the latest GLib build of
`main`, and publish them on docs.gtk.org, as is currently done for the
platform agnostic documentation.

Signed-off-by: Philip Withnall <pwithnall@gnome.org>

Helps: #3037
2024-02-12 17:54:35 +00:00
Philip Withnall
434d3ff524 docs: Mention GioUnix-2.0 GIR namespace alongside gio-unix-2.0.pc
This should clarify things a little for users of language bindings, who
don’t directly use `.pc` files.

Signed-off-by: Philip Withnall <pwithnall@gnome.org>
2024-02-12 17:54:10 +00:00