Coding Style

Code formatting

The code formatting in the openChrome driver is currently a mess. It is the result of having several different developers, each coding in his own way. The goal is to get as close as possible to some kind of Xorg unified coding style. If the instructions below differ substantially from what's current practice, they will be revised.

• Function names start with a lowercase letter and are written like this:

  viaFunctionName()

  As a general rule all functions should start with the prefix "via", however to improve clarity, static functions are allowed to start with other names.
• Variables also start with a lowercase letter:

  numOfScreens

  Global variables should be avoided.
• Type names start with an uppercase letter:

  ViaMagicType

  Structs are wrapped with typedef.

Indentation and general formatting should be done with the command:

See also the Xorg coding style page.

ChangeLog

Before committing something to the SVN repository, you should produce a ChangeLog? entry. When merging a branch, don't incorporate all ChangeLog? entries from the branch into the trunk. Just mention that you've merged a specific branch between revisions x and y, and where the detailed changelog can be found. To aid in ChangeLog? writing, go to the directory where the ChangeLog? file is created and run the script which will create a changelog entry for you to fill in. Use the same text for the commit message.