X-Git-Url: https://git.sur5r.net/?a=blobdiff_plain;f=docs%2Fhacking-howto;h=74a690e7c1ef65d323d5a5f0b03338b3c7b60c79;hb=bd29745effe949aed847d4e8a519c66696ff6025;hp=e6313f7d6837fd85da3059116fd73e962e9751fe;hpb=9d65f595714d31c8ce46f6956b2f502d9efe5225;p=i3%2Fi3 diff --git a/docs/hacking-howto b/docs/hacking-howto index e6313f7d..74a690e7 100644 --- a/docs/hacking-howto +++ b/docs/hacking-howto @@ -117,7 +117,7 @@ containers, searching containers, getting specific properties from containers, src/config.c:: Contains all functions handling the configuration file (calling the parser -(src/cfgparse.y) with the correct path, switching key bindings mode). +src/config_parser.c) with the correct path, switching key bindings mode). src/debug.c:: Contains debugging functions to print unhandled X events. @@ -187,7 +187,7 @@ cleanup ("flatten") the tree. See also +src/move.c+ for another similar function, which was moved into its own file because it is so long. src/util.c:: -Contains useful functions which are not really dependant on anything. +Contains useful functions which are not really dependent on anything. src/window.c:: Handlers to update X11 window properties like +WM_CLASS+, +_NET_WM_NAME+, @@ -593,7 +593,7 @@ optimize this and call +x_push_node+ on the appropriate con directly. itself for the container’s children. This function actually pushes the state, see the next paragraph. 4. If the pointer needs to be warped to a different position (for example when - changing focus to a differnt output), it will be warped now. + changing focus to a different output), it will be warped now. 5. The eventmask is restored for all mapped windows. 6. Window decorations will be rendered by calling +x_deco_recurse+ on the root container, which then recursively calls itself for the children. @@ -850,7 +850,7 @@ empty. Afterwards, +con_focus+ will be called to fix the focus stack and the tree will be flattened. -=== Case 3: Moving to non-existant top/bottom +=== Case 3: Moving to non-existent top/bottom Like in case 1, the reference layout for this case is a single workspace in horizontal orientation with two containers on it. Focus is on the left @@ -877,7 +877,7 @@ container and the container above/below the current one (on the level of Now, +con_focus+ will be called to fix the focus stack and the tree will be flattened. -=== Case 4: Moving to existant top/bottom +=== Case 4: Moving to existent top/bottom The reference layout for this case is a vertical workspace with two containers. The bottom one is a h-split containing two containers (1 and 2). Focus is on @@ -982,14 +982,16 @@ could have a look at previous reviews and see what the common mistakes are. === Which branch to use? -Work on i3 generally happens in two branches: “master” and “next”. Since -“master” is what people get when they check out the git repository, its -contents are always stable. That is, it contains the source code of the latest -release, plus any bugfixes that were applied since that release. +Work on i3 generally happens in two branches: “master” and “next” (the latter +being the default branch, the one that people get when they check out the git +repository). + +The contents of “master” are always stable. That is, it contains the source code +of the latest release, plus any bugfixes that were applied since that release. New features are only found in the “next” branch. Therefore, if you are working -on a new feature, use the “next” branch. If you are working on a bugfix, use -the “next” branch, too, but make sure your code also works on “master”. +on a new feature, use the “next” branch. If you are working on a bugfix, use the +“next” branch, too, but make sure your code also works on “master”. == Thought experiments