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
tree: 3f131e22a354aee026914bb87407835fb2662d42
  1. .gitlab-ci/
  2. .reuse/
  3. docs/
  4. fuzzing/
  5. gio/
  6. girepository/
  7. glib/
  8. gmodule/
  9. gobject/
  10. gthread/
  11. LICENSES/
  12. m4macros/
  13. po/
  14. subprojects/
  15. tests/
  16. tools/
  17. .clang-format
  18. .dir-locals.el
  19. .editorconfig
  20. .gitignore
  21. .gitlab-ci.yml
  22. .gitmodules
  23. .lcovrc
  24. CODE_OF_CONDUCT.md
  25. CONTRIBUTING.md
  26. glib.doap
  27. INSTALL.md
  28. meson.build
  29. meson_options.txt
  30. NEWS
  31. README.md
  32. SECURITY.md
README.md

GLib

GLib is the low-level core library that forms the basis for projects such as GTK and GNOME. It provides data structure handling for C, portability wrappers, and interfaces for such runtime functionality as an event loop, threads, dynamic loading, and an object system.

The official download locations are: https://download.gnome.org/sources/glib

The official web site is: https://www.gtk.org/

Installation

See the file ‘INSTALL.md’. There is separate and more in-depth documentation for building GLib on Windows.

Supported versions

Upstream GLib only supports the most recent stable release series, the previous stable release series, and the current development release series. All older versions are not supported upstream and may contain bugs, some of which may be exploitable security vulnerabilities.

See SECURITY.md for more details.

Documentation

API documentation is available online for GLib for the:

Discussion

If you have a question about how to use GLib, seek help on GNOME’s Discourse instance. Alternatively, ask a question on StackOverflow and tag it glib.

Reporting bugs

Bugs should be reported to the GNOME issue tracking system. You will need to create an account for yourself. You may also submit bugs by e-mail (without an account) by e-mailing incoming+gnome-glib-658-issue-@gitlab.gnome.org, but this will give you a degraded experience.

Bugs are for reporting problems in GLib itself, not for asking questions about how to use it. To ask questions, use one of our discussion forums.

In bug reports please include:

  • Information about your system. For instance:
    • What operating system and version
    • For Linux, what version of the C library
    • And anything else you think is relevant.
  • How to reproduce the bug.
    • If you can reproduce it with one of the test programs that are built in the tests/ subdirectory, that will be most convenient. Otherwise, please include a short test program that exhibits the behavior. As a last resort, you can also provide a pointer to a larger piece of software that can be downloaded.
  • If the bug was a crash, the exact text that was printed out when the crash occurred.
  • Further information such as stack traces may be useful, but is not necessary.

Contributing to GLib

Please follow the contribution guide to know how to start contributing to GLib.

Patches should be submitted as merge requests to gitlab.gnome.org. If the patch fixes an existing issue, please refer to the issue in your commit message with the following notation (for issue 123):

Closes: #123

Otherwise, create a new merge request that introduces the change. Filing a separate issue is not required.