Google Git
Sign in
fuchsia / third_party / glib / a60e6bedaede5cf0cf6e2e0ed5f4ad824a7446c3
commita60e6bedaede5cf0cf6e2e0ed5f4ad824a7446c3[log] [tgz]
authorPhilip Withnall <pwithnall@gnome.org>Wed Mar 06 13:25:38 2024 +0000
committerPhilip Withnall <pwithnall@gnome.org>Thu Mar 07 13:12:07 2024 +0000
tree7e5574c5fc9b818d60cba2140ce93225c57a0750
parentfafe1a14a88044eb87190640f66963796bc0d9f1 [diff]
docs: Document that signal connection functions cannot fail

The documentation previously implied that they could. That’s not really
true though: they can only fail if preconditions fail, i.e. they’re
passed invalid input. That’s a programmer error, which is not something
we want to encourage people to check for at runtime (e.g. by dynamically
checking for a 0 return value).

Signed-off-by: Philip Withnall <pwithnall@gnome.org>
2 files changed
tree: 7e5574c5fc9b818d60cba2140ce93225c57a0750
  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. COPYING ⇨ LICENSES/LGPL-2.1-or-later.txt
  18. .clang-format
  19. .dir-locals.el
  20. .editorconfig
  21. .gitignore
  22. .gitlab-ci.yml
  23. .gitmodules
  24. .lcovrc
  25. CODE_OF_CONDUCT.md
  26. CONTRIBUTING.md
  27. glib.doap
  28. INSTALL.md
  29. meson.build
  30. meson_options.txt
  31. NEWS
  32. README.md
  33. 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.