Developing for FVWM
This document aims to help the developer with the expectations when dealing with the FVWM3 source code.
The FVWM3 source conforms to the Linux kernel style guide.
The internal representation of how fvwm3 parses commands in undergoing a rewrite. Some notes on how fvwm3 parses commands exists.
Branch Workflows / Submitting Code Changes
The main FVWM3 repository treats the
master branch as stable, in that it's the
branch which has the most tested code on it, and the branch from which releases
are made. Formal releases of FVWM3 are tagged, in the form
versions of FVWM3 are tagged as
version-x_y_z. Untagged code may well
master, which will go to form the next release.
Other branches in the repository will reflect on-going development from core fvwm-workers. As such, these branches are often in a state of flux, and likely to be rebased against other branches. NO code should be based off topic branches, unless explicitly agreed with other developers, who might need to collaborate.
Branch names are used to try and indicate the feature, and who is working on them. So for example, a topic-branch will be named as:
denotes that the branch is worked on by someone with the initials
TA and that
the branch is about fixing warnings from Clang.
Sometimes, if more than one person is collaborating on a branch, the initials prefix might not be needed.
External contributions are always welcomed and encouraged. If you're thinking
of writing a new feature, it is worthwhile opening an issue against the
repository to discuss whether it's a good idea, and to check no one else is
working on that feature.
Those wishing to submit code/bug-fixes should:
- Fork the FVWM3-repository
- Add the FVWM3-repo as an upstream
git remote add fvwmorg https://github.com/fvwmorg/fvwm3.git && git fetch fvwmorg
- Create a topic-branch to house your work:
git switch -b initial/mybranch
- [ hack, hack, hack... ] && commit
- Rebase it against
git fetch && git rebase -i fvwmorg/master
- Push the latest changes to your fork:
- If you've never pushed this branch before:
git push -u origin HEAD
- Or, if updating an existing branch:
git push origin -f
- If you've never pushed this branch before:
- Open a pull-request
Protected branches and the use of Github Actions
Pull-requests made will result in the use of Github Actions being run against the branch. This builds the copy of the pushed code in a Debian environment, with all the additional libraries FVWM could use, loaded in. If a build fails this check, it is recommend to fix this by rebasing the commits with the additional fixes
The FVWM3 repository also treats the
master branch as protected. This is a
which means the
master branch in this case cannot have changes merged into it
until Github Actions has verified the builds do not fail.
This has merit since not every developer will be using the same operating
systems (Linux versus BSD for instance), and that
master is meant to try and
be as release-worthy as can be.
NOTE: This means that no work can be committed to
master directly. ALL
work that needs to appear on
master---including the release
process---MUST go via a separate topic-branch, with a PR (pull-request).
Not even fvwmorg owners are an exception to this.
Merging changes / Pull Requests
The history of
master should be as linear as possible, therefore when
merging changes to it the branch(es) in question should be rebased against
master first of all. This will stop a merge commit from happening.
If using github this process is easy, since the
Merge pull request button
has an option to
Rebase and Merge. This is what should be used. See also
the documentation on Github
If this is manual (which will only work when the Github Actions checks have passed), then:
git checkout topic/branch git fetch --all git rebase -i origin/master git checkout master git merge topic/branch git push
The following tries to list all the conventions that the fvwm developers adhere to, either by consensus through discussion, common practice or unspoken agreement. It is hopefully useful for the fvwm development newbie.
The following programming languages are allowed:
- ANSI C
- Portable /bin/sh scripts for examples.
At the top-level of the
fvwm3 git repo, is a .editorconfig
file which sets some options which can be used across different editors. See
the editorconfig webpage for more information and
to see whether your editor is supported.
New Code Files
- All .c files must have
as the first non-comment line. Otherwise the settings made by the configure script may not be used. This can cause random problems.
- The names of the code files in the fvwm directory are in lower case.
- Files in the libs directory may begin with a capital 'F'. This letter is reserved for wrapper files for third party libraries or modules. For example, FShape is an abstraction of the XShape X server extension and FBidi is a wrapper for the fribidi library. Do not use the 'F' for other purposes.
- A copy of the GPL should be at the beginning of all code files (.c) and scripts, but not at the beginning of header files (.h).
Maintaining Man Pages
- Every feature must be described with all options in the man page. Man pages
are generated via Asciidoctor from files in
Creating a release
Make sure you have all optional libraries installed.
master is a protected branch, changes made to files during the
release phase must be done on a separate branch, and not on master directly,
as pushes to this branch are not allowed until checks have been done on it.
This means the end result of the release-phase must have these changes issued
as a pull-request against
git checkout master && git pull && git checkout -b release/x.y.zWhere:
x.y.zwill be the next release.
Change the dates in configure.ac and fill in the release dates.
utils/fvwm-version-str.shand include the appropriate version string.
Commit the results.
./autogen.sh && make cleanto get the tree into a clean slate. Because this is a release, the source needs compiling. To do that, run:
make CFLAGS="-g -O2 -Wall -Wpointer-arith -fno-strict-aliasing -Werror"
Fix all warnings and problems, commit the changes and repeat the previous command until no more warnings occur.
Tag the release:
git tag -a x.y.z-- where
x.y.zrepresents the appropriate version number for the release.
Build and test the release tarballs:
If that succeeds, check for
fvwm-x.y.z.tar.gzin the current working directory. This is the release tarball which will be uploaded to Github. Unpack it to a temporary directory and build it; check the version as well, via:
Push the tag out:
git push origin x.y.z-- where
x.y.zis the specific tag created in step 6.
"no"in configure.ac and commit and push that out.
Issue a PR (pull-request) against
masterand merge that in assuming all checks pass. If not, fix the problems, and repeat this step.
fvwm-x.y.z.tar.gztarball to Github against the tag just pushed.
Update the fvwm web site (see below)
Ensure you've a checkout of the repository:
git clone email@example.com:fvwmorg/fvwmorg.github.io.git
Makefileto the desired version which has been released.
make. This will update all relevant files.
git commit -athe result, and push it out.