Text Editor Settings

[WIP] discuss using LF and white space remover etc.

Below is information on requirements needed when using a text editor to work on LinuxGSM code. All the recommended text editors can be set up to take into account the requirements.

Indentation

LinuxGSM uses tabs instead of spaces, it is possible to specify tabs and convert spaces to tabs if required.

Line Ending

All files must be saved using LF (Line Feed) line endings which is the line ending used by UNIX based systems. Please ensure that your text editor is saving in LF format as failure to do so will cause BASH scripts to stop functioning.

For more info about line endings check out the article "The Great Newline Schism".

Trailing White Spaces

When developing code sometimes it can be easy to end up with trailing white spaces. as shown below.

fn_example_func(){
    # The line below has two spaces after its final character
    code••
}

All code must have whitespaces removed to keep code tidy. Many text editors have a feature that will automaticly remove trailing whitespaces when a file is saved. It is highly reccomended this feature is turned on.