From 4b9702703467416fc51f6ec715638bce8556fc90 Mon Sep 17 00:00:00 2001 From: Orestis Floros Date: Sat, 2 May 2020 19:44:32 +0200 Subject: [PATCH] hacking-howto: Add warning --- .github/CONTRIBUTING.md | 2 +- docs/hacking-howto | 14 ++++++++++++++ 2 files changed, 15 insertions(+), 1 deletion(-) diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.md index 12292746..40fd8399 100644 --- a/.github/CONTRIBUTING.md +++ b/.github/CONTRIBUTING.md @@ -38,4 +38,4 @@ Note that bug reports and feature requests for related projects should be filed * Find a [reproducible bug](https://github.com/i3/i3/issues?utf8=%E2%9C%93&q=is%3Aopen+label%3Areproducible+label%3Abug+) from the issue tracker. These issues have been reviewed and confirmed by a project contributor. * Find an [accepted enhancement](https://github.com/i3/i3/issues?utf8=%E2%9C%93&q=is%3Aopen+label%3Aaccepted+label%3Aenhancement) from the issue tracker. These have been approved and are ok to start working on. -There's a very good [overview of the codebase](https://i3wm.org/docs/hacking-howto.html) available to get you started. +There's an [overview of the codebase](https://i3wm.org/docs/hacking-howto.html) available to get you started. diff --git a/docs/hacking-howto b/docs/hacking-howto index 7cece9ef..ff3c89bc 100644 --- a/docs/hacking-howto +++ b/docs/hacking-howto @@ -8,6 +8,19 @@ touching i3’s source code. It should contain all important information to help you understand why things are like they are. If it does not mention something you find necessary, please do not hesitate to contact me. +++++ +
+WARNING! +

+++++ +This document is not 100% up to date. Specifically, everything up to and +including <> has been updated recently. The rest might contain +outdated information. +++++ +

+
+++++ + == Building i3 You can build i3 like you build any other software package which uses autotools. @@ -246,6 +259,7 @@ A file containing all X11 atoms which i3 uses. This file will be included various times (for defining, requesting and receiving the atoms), each time with a different definition of xmacro(). +[[data_structures]] == Data structures See +include/data.h+ for documented data structures. The most important ones are