Philip Withnall
9ea0b6edf5
docs: Set install_tag on man pages
...
Signed-off-by: Philip Withnall <pwithnall@gnome.org>
Helps: #3037
2023-12-18 14:52:39 +00:00
Philip Withnall
11e46361ef
docs: Add GIRepository documentation build using gi-docgen
...
Signed-off-by: Philip Withnall <pwithnall@gnome.org>
Helps: #3155
2023-12-12 16:58:04 +00:00
Emmanuele Bassi
9a2de39044
docs: Add a section on version checking macros
...
This is a port to GLib of changes originally made in the GTK copy of
these docs, at https://gitlab.gnome.org/GNOME/gtk/-/commit/72b0a4431d04 .
(Copied across by Philip Withnall.)
Helps: #3037
2023-12-12 13:59:43 +00:00
Philip Withnall
d86da581e6
Merge branch 'main' into 'main'
...
Documentation only: Added clarification about GWeakNotify and removed ambiguous text
See merge request GNOME/glib!3739
2023-12-03 22:48:47 +00:00
madmurphy
abd7f9863d
Documentation only: Added clarification about GWeakNotify and removed ambiguous text
2023-12-03 22:48:46 +00:00
Emmanuele Bassi
b53218a509
Merge branch '3037-doc-build-cleanups' into 'main'
...
build: Rename -Dgtk_doc option to -Ddocumentation and fix some g-ir-scanner warnings
See merge request GNOME/glib!3736
2023-12-01 22:48:17 +00:00
Philip Withnall
7b2ac3c82e
docs: Consistently capitalise page titles
...
Signed-off-by: Philip Withnall <pwithnall@gnome.org>
Helps: #3037
2023-11-29 12:13:13 +00:00
Philip Withnall
e8edaeeb87
build: Rename -Dgtk_doc option to -Ddocumentation
...
Because the documentation is no longer built using gtk-doc.
Keep the old option around, but deprecated.
Signed-off-by: Philip Withnall <pwithnall@gnome.org>
Helps: #3037
2023-11-29 10:26:37 +00:00
Matthias Clasen
6ca2934928
build: Remove all remaining gtk-doc build infrastructure
...
It’s no longer needed: the documentation is built by gi-docgen now.
Fixes : #3037
2023-11-28 13:52:35 +00:00
Philip Withnall
0fe3a9d1df
docs: Drop the tools tutorial page
...
It’s completely out of date.
Signed-off-by: Philip Withnall <pwithnall@gnome.org>
Helps: #3037
2023-11-28 13:52:05 +00:00
Philip Withnall
54eb9b8900
docs: Convert the resources page to Markdown
...
And change mentions of ‘mailing lists’ to ‘support’ while I’m there.
Signed-off-by: Philip Withnall <pwithnall@gnome.org>
Helps: #3037
2023-11-28 13:52:05 +00:00
Philip Withnall
2c4a0c83e1
docs: Drop the regex-syntax page
...
Point people to the official PCRE documentation instead, which is going
to be more up to date. This saves us periodically having to copy in and
reformat the PCRE documentation.
Signed-off-by: Philip Withnall <pwithnall@gnome.org>
Helps: #3037
2023-11-28 13:52:05 +00:00
Philip Withnall
ed5c17018f
docs: Convert the programming page to Markdown
...
Signed-off-by: Philip Withnall <pwithnall@gnome.org>
Helps: #3037
2023-11-28 13:52:05 +00:00
Philip Withnall
59a4a239a1
docs: Remove the ‘changes to GLib’ page
...
We haven’t made any backwards-incompatible changes since GLib 2.2 in
2002. It’s probably not very useful to tell people about those any more.
Signed-off-by: Philip Withnall <pwithnall@gnome.org>
Helps: #3037
2023-11-28 13:52:05 +00:00
Philip Withnall
94d2265429
docs: Convert the migrating-posix page to Markdown
...
Signed-off-by: Philip Withnall <pwithnall@gnome.org>
Helps: #3037
2023-11-28 13:52:05 +00:00
Philip Withnall
e2efafb857
docs: Delete the generated gdbus-object-manager-example docs
...
They were previously `xi:include`d into some of the GDBus documentation,
but since the GDBus documentation was ported to Markdown that’s no
longer possible, so the object manager example docs now serve no
purpose.
Signed-off-by: Philip Withnall <pwithnall@gnome.org>
Helps: #3037
2023-11-28 13:52:05 +00:00
Philip Withnall
6a22d58f6b
docs: Move the types SECTION
...
Move it to a mega separate file.
This has been a journey.
Signed-off-by: Philip Withnall <pwithnall@gnome.org>
Helps: #3037
2023-11-28 13:52:05 +00:00
Philip Withnall
33c10e8711
docs: Move the windows SECTION
...
Move it to a separate file.
Signed-off-by: Philip Withnall <pwithnall@gnome.org>
Helps: #3037
2023-11-28 13:52:05 +00:00
Philip Withnall
3532e3ca1c
docs: Move the warnings SECTION
...
Move it to a separate file.
Signed-off-by: Philip Withnall <pwithnall@gnome.org>
Helps: #3037
2023-11-28 13:52:05 +00:00
Philip Withnall
877b0affb6
docs: Move the numerical SECTION
...
Move it to a separate Markdown file.
Signed-off-by: Philip Withnall <pwithnall@gnome.org>
Helps: #3037
2023-11-28 13:52:05 +00:00
Philip Withnall
3957b47e59
docs: Move the checkedmath SECTION
...
Move it to a separate Markdown file.
Signed-off-by: Philip Withnall <pwithnall@gnome.org>
Helps: #3037
2023-11-28 13:52:05 +00:00
Philip Withnall
b93e35dc17
docs: Move the datalist and dataset SECTIONs
...
Move them to a separate page as they don’t really have a ‘class’ struct
each to hang docs off.
Signed-off-by: Philip Withnall <pwithnall@gnome.org>
Helps: #3037
2023-11-28 13:52:05 +00:00
Philip Withnall
790131687c
docs: Move the unix SECTION
...
Move it to a separate page.
Signed-off-by: Philip Withnall <pwithnall@gnome.org>
Helps: #3037
2023-11-28 13:52:05 +00:00
Philip Withnall
244721baf9
docs: Move the misc_utils SECTION
...
Move it to a separate page, with a massive great list of all the misc
utils. Not a great documentation page, but equivalent to what we had
before, and it can be improved in future.
Signed-off-by: Philip Withnall <pwithnall@gnome.org>
Helps: #3037
2023-11-28 13:52:05 +00:00
Philip Withnall
74de872bb9
docs: Move the spawn SECTION
...
Move it to a separate page.
Signed-off-by: Philip Withnall <pwithnall@gnome.org>
Helps: #3037
2023-11-28 13:52:05 +00:00
Philip Withnall
6dca578f9d
docs: Move the memory SECTION
...
Move it to a separate page.
Signed-off-by: Philip Withnall <pwithnall@gnome.org>
Helps: #3037
2023-11-28 13:52:05 +00:00
Philip Withnall
25a4205d9d
docs: Move the ghostutils SECTION
...
Sadly, this is about hostnames rather than ghosts. 😞
Signed-off-by: Philip Withnall <pwithnall@gnome.org>
Helps: #3037
2023-11-28 13:52:05 +00:00
Philip Withnall
425731f766
docs: Move the string_utils SECTION
...
Move it to a mega separate file.
Signed-off-by: Philip Withnall <pwithnall@gnome.org>
Helps: #3037
2023-11-28 13:52:05 +00:00
Philip Withnall
cf52727f03
docs: Move the shell SECTION
...
Move it to a separate file.
Signed-off-by: Philip Withnall <pwithnall@gnome.org>
Helps: #3037
2023-11-28 13:52:05 +00:00
Philip Withnall
229b76a388
docs: Move the version SECTION
...
Move it to a separate documentation file, since most of what’s covered
isn’t introspectable.
Signed-off-by: Philip Withnall <pwithnall@gnome.org>
Helps: #3037
2023-11-28 13:52:05 +00:00
Philip Withnall
359c1034e0
docs: Move the GUuid SECTION
...
Move it to a separate page as there’s no public struct to hang the
docs off.
Signed-off-by: Philip Withnall <pwithnall@gnome.org>
Helps: #3037
2023-11-28 13:52:05 +00:00
Philip Withnall
43588fcdd9
docs: Move the grand SECTION
...
Move it to a separate page so the difference between `g_rand_*()` and
`g_random_*()` can be explained.
Signed-off-by: Philip Withnall <pwithnall@gnome.org>
Helps: #3037
2023-11-28 13:52:05 +00:00
Philip Withnall
158ec5be34
docs: Move the gfileutils SECTION
...
Move it to a separate page so more detail can be provided about all the
groups of API.
Signed-off-by: Philip Withnall <pwithnall@gnome.org>
Helps: #3037
2023-11-28 13:52:05 +00:00
Philip Withnall
c850d25d67
docs: Move the gatomic SECTION
...
Move it to a standalone page.
Signed-off-by: Philip Withnall <pwithnall@gnome.org>
Helps: #3037
2023-11-28 13:52:05 +00:00
Philip Withnall
ac91b8f4a2
docs: Move the base64 SECTION
...
Move it to a separate file as there is no struct to hang the docs off.
Signed-off-by: Philip Withnall <pwithnall@gnome.org>
Helps: #3037
2023-11-28 13:52:05 +00:00
Philip Withnall
552f62a059
docs: Move the threads-deprecated SECTION
...
Move it to a separate page so an overview of the deprecated threading
API can be given.
Signed-off-by: Philip Withnall <pwithnall@gnome.org>
Helps: #3037
2023-11-28 13:52:05 +00:00
Philip Withnall
8f6f382940
Merge branch 'test-trap-subprocess-envp' into 'main'
...
gtestutils: Add g_test_trap_subprocess_with_envp() for testing envs
See merge request GNOME/glib!3721
2023-11-28 11:49:11 +00:00
Aleksandr Mezin
c03c983d94
gapplicationcommandline: add .done()
method
...
Fixes #596
2023-11-27 14:15:36 +00:00
Philip Withnall
6a6b36bbc7
gtestutils: Add g_test_trap_subprocess_with_envp() for testing envs
...
This is a variant of `g_test_trap_subprocess()` which allows the
environment for the child process to be specified. This is quite useful
when you want to test code which reads environment variables, as it’s
not safe to set those after the start of `main()`.
This will be useful within and outwith GLib for testing such code.
Signed-off-by: Philip Withnall <pwithnall@gnome.org>
Helps: #1618
2023-11-23 12:18:21 +00:00
Philip Withnall
6e4d50fa5c
docs: Move the gunixmounts SECTION
...
Move it to a separate page.
Signed-off-by: Philip Withnall <pwithnall@gnome.org>
Helps: #3037
2023-11-15 11:48:23 +00:00
Philip Withnall
9c414d437e
docs: Move the gpollableutils SECTION
...
Move it to a separate page.
Signed-off-by: Philip Withnall <pwithnall@gnome.org>
Helps: #3037
2023-11-15 11:48:23 +00:00
Philip Withnall
708de2fc12
docs: Move the gnetworking SECTION
...
Move it to a separate page.
Signed-off-by: Philip Withnall <pwithnall@gnome.org>
Helps: #3037
2023-11-15 11:48:23 +00:00
Philip Withnall
de8e39b344
docs: Move the gmenumodel SECTION
...
Move it to a separate page, since it doesn’t quite make sense to
incorporate into the `GDBusConnection` docs.
Signed-off-by: Philip Withnall <pwithnall@gnome.org>
Helps: #3037
2023-11-15 11:48:23 +00:00
Philip Withnall
ef049cbaca
docs: Move the GIOScheduler SECTION
...
Move it to a separate page, as there isn’t a `GIOScheduler` struct.
Ensure that all its functions/methods/types are correctly marked as
deprecated. Fix a few broken links about I/O priority which pointed to
it.
Signed-off-by: Philip Withnall <pwithnall@gnome.org>
Helps: #3037
2023-11-15 11:48:23 +00:00
Philip Withnall
fe8785862a
docs: Move the GIOError SECTION
...
Move it to a separate page as there’s no struct documentation to hang it
off.
Signed-off-by: Philip Withnall <pwithnall@gnome.org>
Helps: #3037
2023-11-14 14:32:19 +00:00
Philip Withnall
74735d878f
docs: Move the dbusutils SECTION
...
Move it to a separate page as there’s no struct to hang the
documentation off.
Signed-off-by: Philip Withnall <pwithnall@gnome.org>
Helps: #3037
2023-11-14 14:32:19 +00:00
Philip Withnall
6492dd7054
docs: Move the GDBus name watching SECTION
...
Move it to a separate content page as there’s no struct to hang the docs
off.
Signed-off-by: Philip Withnall <pwithnall@gnome.org>
Helps: #3037
2023-11-14 14:32:19 +00:00
Philip Withnall
beb56279ef
docs: Move the GDBus name owning SECTION
...
Move it to a separate content page as there’s no struct to hang the docs
off.
Signed-off-by: Philip Withnall <pwithnall@gnome.org>
Helps: #3037
2023-11-14 14:32:19 +00:00
Philip Withnall
c7e21d2f59
docs: Move the GDBusIntrospection SECTION
...
Move it to a separate content page as there is no `GDBusIntrospection`
type to hang the rest of the documentation off.
Signed-off-by: Philip Withnall <pwithnall@gnome.org>
Helps: #3037
2023-11-14 14:32:19 +00:00
Philip Withnall
84bed2f6ae
docs: Move the GDBusError SECTION
...
Adding it all to the docs for the `GDBusError` enum seemed a bit much,
so I moved it to its own content page.
Signed-off-by: Philip Withnall <pwithnall@gnome.org>
Helps: #3037
2023-11-14 14:32:19 +00:00
Alexander Slobodeniuk
7880d87091
gvalue: add g_value_steal_string()
...
This call is needed to avoid an extra copy after
serialization of the data.
2023-11-04 10:40:30 +00:00
Philip Withnall
ac7cbb146e
docs: Move the gtls SECTION
...
Move it to a separate Markdown page.
Signed-off-by: Philip Withnall <philip@tecnocode.co.uk>
Helps: #3037
2023-11-02 16:30:23 +00:00
Emmanuele Bassi
3dbef3223b
build: Fix the inclusion paths for GIR files in gi-docgen
...
The GIR files are now built by GLib itself, so they will be in the build
directories of each sub-library, except for GLib-2.0 which is built
alongside GObject-2.0.
2023-11-02 11:22:06 +00:00
Michael Catanzaro
eadbdb439e
Merge branch 'meson-version-bump' into 'main'
...
build: Bump Meson dependency to 1.2.0
See merge request GNOME/glib!3666
2023-10-25 13:23:53 +00:00
Alex Richardson
d0e03f0930
GType: introduce GTYPE_TO_POINTER/GPOINTER_TO_TYPE
...
On CHERI-enabled systems we use uintptr_t as the underlying storage for
GType and therefore casting to gsize strips the upper bits from a pointer.
Fix this by casting via uintptr_t instead and introduce a new set of
macros to convert between GType and pointers.
2023-10-25 12:01:02 +01:00
Philip Withnall
4ce58df854
build: Change configure_file() to fs.copyfile() when copy is set
...
Meson has preferred `fs.copyfile()` since 0.62. This fixes a set of
Meson warnings.
Signed-off-by: Philip Withnall <philip@tecnocode.co.uk>
2023-10-25 11:20:36 +01:00
Philip Withnall
508e164056
docs: Move the GFileAttribute SECTION to Markdown
...
It needs to be in a separate page because there isn’t actually a
`GFileAttribute` type.
Signed-off-by: Philip Withnall <philip@tecnocode.co.uk>
Helps: #3037
2023-10-23 13:43:27 +01:00
Philip Withnall
824ae3f931
docs: Move the GIcon SECTION
...
Move it to the struct docs.
Signed-off-by: Philip Withnall <philip@tecnocode.co.uk>
Helps: #3037
2023-10-23 13:18:13 +01:00
Philip Withnall
5ae6bcb728
docs: Move the value collection documentation to Markdown
...
It needs to be in a separate page because it’s all macros and they have
no type/class associated with them.
Signed-off-by: Philip Withnall <philip@tecnocode.co.uk>
Helps: #3037
2023-10-23 13:18:13 +01:00
Philip Withnall
a6aaa701a5
docs: Mention dependency cycle between GLib and gobject-introspection
...
And how to break that cycle.
Signed-off-by: Philip Withnall <philip@tecnocode.co.uk>
Helps: #3037
2023-10-23 11:26:53 +01:00
Emmanuele Bassi
160e5db742
Remove old introspection data
...
We don't need it any more.
2023-10-23 11:26:53 +01:00
Emmanuele Bassi
3ffa33825b
Build the API references with the generated GIR data
...
Gate the API reference on the availability of the introspection data as
well, so we don't accidentally try and generate the documentation
without a description of our API.
2023-10-23 11:26:53 +01:00
Aleksandr Mezin
b9c90c3a3e
GApplicationCommandLine: add print[err]_literal()
...
GJS (and likely other language bindigs relying on introspection)
can't use `g_application_command_line_print()`/`_printerr()`.
2023-10-18 01:20:23 +03:00
Matthias Clasen
95717eacea
docs: Move the signal SECTION
...
Move the content to the new signals.md file.
Helps: #3037
2023-10-16 23:34:35 +01:00
Matthias Clasen
f3eac349f9
docs: Move the GType SECTION
...
Move the contents to the new types.md files.
Helps: #3037
2023-10-16 23:34:29 +01:00
Sid
027f4b4c73
Cleanup and add content to glib debugging using gdb scripts
2023-10-16 08:50:39 +00:00
Guido Günther
bc4ba05d34
gstrvbuilder: Add g_strv_builder_take
...
g_strv_builder_take() allows to transfer ownership of the passed in
string.
This can be useful to avoid additional allocations when using functions
that transfer ownership to the caller like g_strdup_printf().
The testcase uses g_strv_builder_take and g_strv_builder_add to demo
that calls can be mixed.
2023-10-15 15:45:58 +02:00
Matthias Clasen
f27af99233
docs: Move the unicode SECTION
...
Move the content to the new unicode.md file.
Helps: #3037
2023-10-11 17:38:31 +01:00
Matthias Clasen
97cb9fa220
docs: Move the refstring SECTION
...
Move the contents to the data-structures.md file.
Helps: #3037
2023-10-11 17:38:30 +01:00
Matthias Clasen
8164220213
docs: Move the sequence SECTION
...
Add the contents to the data-structures.md file.
Helps: #3037
2023-10-11 17:38:30 +01:00
Matthias Clasen
c226088028
docs: Move the GNode SECTION
...
Move the contents to the data-structures.md file.
Helps: #3037
2023-10-11 17:38:30 +01:00
Matthias Clasen
2191c6024a
docs: Move the tree SECTION
...
Move the content to the new data-structures.md file.
Helps: #3037
2023-10-11 17:38:30 +01:00
Matthias Clasen
0ce33a6fee
docs: Move the asyncqueue SECTION
...
Move the contents to the new data-structures.md file.
Helps: #3037
2023-10-11 17:38:30 +01:00
Matthias Clasen
25aeddd2a7
docs: Move the queue SECTION
...
Add the content to the new data-structures.md file.
Helps: #3037
2023-10-11 17:38:30 +01:00
Matthias Clasen
f88d96e2ad
docs: Move the GHashTable SECTION
...
Move the content to the new data-structures.md file.
Helps: #3037
2023-10-11 17:38:30 +01:00
Matthias Clasen
ed1bc3228b
docs: Move list SECTIONs
...
Move the content to the data-structures.md file.
Helps: #3037
2023-10-11 17:38:30 +01:00
Matthias Clasen
09733b6531
docs: Move the array SECTIONs
...
Move the content to the new data-structures.md file.
Helps: #3037
2023-10-11 17:38:30 +01:00
Philip Withnall
c140f83922
Merge branch 'migrate-to-gi-docgen' into 'main'
...
Switch to using gi-docgen for docs (batch 1)
See merge request GNOME/glib!3591
2023-10-11 15:21:10 +00:00
Matthias Clasen
ab066d4856
docs: Move the GOption SECTION
...
Move the content to the new goption.md file.
Helps: #3037
2023-10-11 14:01:29 +01:00
Matthias Clasen
8b9c4cfb87
docs: Move the GMarkup SECTION
...
Move the content to the new markup.md file.
Helps: #3037
2023-10-11 14:01:29 +01:00
Matthias Clasen
3d55be0b82
docs: Move the GObject tutorial to Markdown
...
Helps: #3037
2023-10-11 14:01:29 +01:00
Matthias Clasen
682e9c9f56
docs: Move migrating-gdbus.xml to Markdown
...
This copies the test code inline into the Markdown, which means it could
diverge from the test code which is compiled and run as part of the
tests. That needs improving, but that can happen in a subsequent commit.
Helps: #3037
2023-10-11 14:01:29 +01:00
Matthias Clasen
e1d6168e5b
docs: Move the auto-cleanup documentation to Markdown
...
Helps: #3037
2023-10-11 14:01:29 +01:00
Matthias Clasen
c2798e6c2a
docs: Move building documentation to Markdown
...
Helps: #3037
2023-10-11 14:01:29 +01:00
Matthias Clasen
abf99f533f
docs: Move compiling documentation to Markdown
...
Helps: #3037
2023-10-11 14:01:29 +01:00
Matthias Clasen
4784bb10b1
docs: Move the cross-compilation documentation to Markdown
...
Helps: #3037
2023-10-11 14:01:29 +01:00
Matthias Clasen
057f4fa2a5
docs: Move GVariant Format Strings documentation to Markdown
...
Helps: #3037
2023-10-11 14:01:29 +01:00
Matthias Clasen
5d80471d4b
docs: Move the GVariant Text Format documentation to Markdown
...
Helps: #3037
2023-10-11 14:01:29 +01:00
Matthias Clasen
758c5de24e
docs: Move the ‘running GLib’ documentation to Markdown
...
Helps: #3037
2023-10-11 14:01:29 +01:00
Matthias Clasen
7c5fc4eb26
docs: Move the GSlice documentation to Markdown
...
Helps: #3037
2023-10-11 14:01:29 +01:00
Matthias Clasen
0d05b87b9f
docs: Move GObject concepts/intro to Markdown
...
Helps: #3037
2023-10-11 14:01:29 +01:00
Matthias Clasen
390d9a446d
docs: Move GModule documentation to Markdown
...
Helps: #3037
2023-10-11 14:01:29 +01:00
Matthias Clasen
fc29022f0b
docs: Move GIO overview to Markdown
...
Helps: #3037
2023-10-11 14:01:29 +01:00
Matthias Clasen
c09f48bb28
docs: Move migrating-gnome-vfs.xml to Markdown
...
Helps: #3037
2023-10-11 14:01:29 +01:00
Matthias Clasen
221ba4e211
docs: Move migrating-gconf.xml to Markdown
...
Helps: #3037
2023-10-11 14:01:29 +01:00
Matthias Clasen
4411023462
docs: Move GValue documentation to Markdown
...
Helps: #3037
2023-10-11 14:01:29 +01:00
Matthias Clasen
e298f1a078
docs: Move floating refs documentation to Markdown
...
And add some new sections on strategies for avoiding designing APIs
around floating refs.
Helps: #3037
2023-10-11 14:01:29 +01:00
Matthias Clasen
58019515d6
docs: Move enum type documentation to Markdown
...
Helps: #3037
2023-10-11 14:01:29 +01:00
Matthias Clasen
24e93078d3
docs: Move boxed type documentation to Markdown
...
And add some additional new content and examples.
Helps: #3037
2023-10-11 14:01:29 +01:00
Matthias Clasen
1a090564d2
docs: Move GTest/test framework documentation to Markdown
...
Helps: #3037
2023-10-11 14:01:29 +01:00