~ubuntu-branches/debian/sid/xiphos/sid

Getting started
===============

Conventions
-----------

All indented lines starting with $ mean enter the command at the command
line. $ stands for the prompt of your shell and should not be part of
your input.

Tools
-----

You need development tools like the C and C++ compiler, make, autoconf,
automake and of course all the header file for the libraries
required by Xiphos. If you are running into any trouble, your system
likely misses something of the required tools or header files. Make
sure to have a complete installtion for developing.

Source code
-----------

If you just want to take a look at the source code, download it from the
Xiphos homepage at

	http://xiphos.sourceforge.net/

There you will find the latest source for the latest offical release. If
you have time and want to contribute to the development, you should consider
using cvs.

Retrieving source code from cvs
-------------------------------

If you are not part of the developer team, you unlikely have read/write
cvs access, therefore you have to login as anonymous user with

	$cvs -d:pserver:anonymous@cvs.xiphos.sourceforge.net:/cvsroot/xiphos login

Just enter enter at the password prompt. After successful login, you can
checkout a fresh copy from cvs with

	$cvs -d:pserver:anonymous@cvs.xiphos.sourceforge.net:/cvsroot/xiphos checkout xiphos

To avoid checking out the full source to look for changes, you can use

	$cvs update

in the toplevel directory of the checked out source code. This retrieve only
the updates done since your last checkout or update.

If you granted read/write access for cvs, you should login with your username
using SSH:

	$export CVS_RSH=ssh
	$cvs -d:ext:username@cvs.xiphos.sourceforge.net:/cvsroot/xiphos login

You should put the export of CVS_RSH in your shell startup file, so you
don't have to type it anytime you use cvs.

Checking out und updating the source stays the same, except for the username

	$cvs -d:ext:username@cvs.xiphos.sourcefort.net:/cvsroot/xiphos checkout

Consider looking into the cvs documentation on your system like

	$man cvs

or
	$info cvs

Maybe you also find more info in the doc directory like /usr/share/doc/cvs.

First make run
--------------

If you retrieved your source from cvs, you should do

	$./autogen.sh

first in the toplevel directory in the source code. If you retrieved the
source from the homepage, untar it

	$tar -xzf xiphos-x.xx.tar.gz

and enter the toplevel directory of the source

	$cd xiphos-x.xx

From this point on, no wether if you use cvs or a tar file, there comes
the widely known configure and make process

	$./configure
	$make

If you now want to install Xiphos, you may have to become root

	$su

which asks you for the root password. After that do

	$make install

to let Xiphos install under /usr/local. Consider developing not as the
root user, as you can screw up your whole system if something went wrong.
Use a normal user account.

If you don't have root right on your system, you can configure Xiphos
with another prefix. For example, your home directory is /home/user. Type

	$./configure --prefix=/home/user

and Xiphos can be installed in your home directory after the make
process.

Hacking the code
----------------

What editor or IDE you use is up to you. Please read ``Coding style'' below
to understand, why indention and formating looks like it looks like.

Xiphos is seperated into three parts:

	- main
	- backend
	- gui

Main is the glue between backend and gui and contains all the code, that
does not belong to backend or gui.

The backend is strictly for communicating with the sword library. It should
not contain anything other.

The gui is, speaking of itself, just for the gui. The aim is, to keep all
gui relevant code out of main and backend, to make it possible to switch
between different guis.

Coding style
------------

The following is taken from the linux kernel source code. Xiphos uses
the same coding style like the linux kernel, so please read it if you
want to start hacking on Xiphos.

		Linux kernel coding style 

This is a short document describing the preferred coding style for the
linux kernel.  Coding style is very personal, and I won't _force_ my
views on anybody, but this is what goes for anything that I have to be
able to maintain, and I'd prefer it for most other things too.  Please
at least consider the points made here. 

First off, I'd suggest printing out a copy of the GNU coding standards,
and NOT read it.  Burn them, it's a great symbolic gesture. 

Anyway, here goes:


	 	Chapter 1: Indentation

Tabs are 8 characters, and thus indentations are also 8 characters. 
There are heretic movements that try to make indentations 4 (or even 2!)
characters deep, and that is akin to trying to define the value of PI to
be 3. 

Rationale: The whole idea behind indentation is to clearly define where
a block of control starts and ends.  Especially when you've been looking
at your screen for 20 straight hours, you'll find it a lot easier to see
how the indentation works if you have large indentations. 

Now, some people will claim that having 8-character indentations makes
the code move too far to the right, and makes it hard to read on a
80-character terminal screen.  The answer to that is that if you need
more than 3 levels of indentation, you're screwed anyway, and should fix
your program. 

In short, 8-char indents make things easier to read, and have the added
benefit of warning you when you're nesting your functions too deep. 
Heed that warning. 


		Chapter 2: Placing Braces

The other issue that always comes up in C styling is the placement of
braces.  Unlike the indent size, there are few technical reasons to
choose one placement strategy over the other, but the preferred way, as
shown to us by the prophets Kernighan and Ritchie, is to put the opening
brace last on the line, and put the closing brace first, thusly:

	if (x is true) {
		we do y
	}

However, there is one special case, namely functions: they have the
opening brace at the beginning of the next line, thus:

	int function(int x)
	{
		body of function
	}

Heretic people all over the world have claimed that this inconsistency
is ...  well ...  inconsistent, but all right-thinking people know that
(a) K&R are _right_ and (b) K&R are right.  Besides, functions are
special anyway (you can't nest them in C). 

Note that the closing brace is empty on a line of its own, _except_ in
the cases where it is followed by a continuation of the same statement,
ie a "while" in a do-statement or an "else" in an if-statement, like
this:

	do {
		body of do-loop
	} while (condition);

and

	if (x == y) {
		..
	} else if (x > y) {
		...
	} else {
		....
	}
			
Rationale: K&R. 

Also, note that this brace-placement also minimizes the number of empty
(or almost empty) lines, without any loss of readability.  Thus, as the
supply of new-lines on your screen is not a renewable resource (think
25-line terminal screens here), you have more empty lines to put
comments on. 


		Chapter 3: Naming

C is a Spartan language, and so should your naming be.  Unlike Modula-2
and Pascal programmers, C programmers do not use cute names like
ThisVariableIsATemporaryCounter.  A C programmer would call that
variable "tmp", which is much easier to write, and not the least more
difficult to understand. 

HOWEVER, while mixed-case names are frowned upon, descriptive names for
global variables are a must.  To call a global function "foo" is a
shooting offense. 

GLOBAL variables (to be used only if you _really_ need them) need to
have descriptive names, as do global functions.  If you have a function
that counts the number of active users, you should call that
"count_active_users()" or similar, you should _not_ call it "cntusr()". 

Encoding the type of a function into the name (so-called Hungarian
notation) is brain damaged - the compiler knows the types anyway and can
check those, and it only confuses the programmer.  No wonder MicroSoft
makes buggy programs. 

LOCAL variable names should be short, and to the point.  If you have
some random integer loop counter, it should probably be called "i". 
Calling it "loop_counter" is non-productive, if there is no chance of it
being mis-understood.  Similarly, "tmp" can be just about any type of
variable that is used to hold a temporary value. 

If you are afraid to mix up your local variable names, you have another
problem, which is called the function-growth-hormone-imbalance syndrome. 
See next chapter. 

		
		Chapter 4: Functions

Functions should be short and sweet, and do just one thing.  They should
fit on one or two screenfuls of text (the ISO/ANSI screen size is 80x24,
as we all know), and do one thing and do that well. 

The maximum length of a function is inversely proportional to the
complexity and indentation level of that function.  So, if you have a
conceptually simple function that is just one long (but simple)
case-statement, where you have to do lots of small things for a lot of
different cases, it's OK to have a longer function. 

However, if you have a complex function, and you suspect that a
less-than-gifted first-year high-school student might not even
understand what the function is all about, you should adhere to the
maximum limits all the more closely.  Use helper functions with
descriptive names (you can ask the compiler to in-line them if you think
it's performance-critical, and it will probably do a better job of it
that you would have done). 

Another measure of the function is the number of local variables.  They
shouldn't exceed 5-10, or you're doing something wrong.  Re-think the
function, and split it into smaller pieces.  A human brain can
generally easily keep track of about 7 different things, anything more
and it gets confused.  You know you're brilliant, but maybe you'd like
to understand what you did 2 weeks from now. 


		Chapter 5: Commenting

Comments are good, but there is also a danger of over-commenting.  NEVER
try to explain HOW your code works in a comment: it's much better to
write the code so that the _working_ is obvious, and it's a waste of
time to explain badly written code. 

Generally, you want your comments to tell WHAT your code does, not HOW. 
Also, try to avoid putting comments inside a function body: if the
function is so complex that you need to separately comment parts of it,
you should probably go back to chapter 4 for a while.  You can make
small comments to note or warn about something particularly clever (or
ugly), but try to avoid excess.  Instead, put the comments at the head
of the function, telling people what it does, and possibly WHY it does
it. 


		Chapter 6: You've made a mess of it

That's OK, we all do.  You've probably been told by your long-time Unix
user helper that "GNU emacs" automatically formats the C sources for
you, and you've noticed that yes, it does do that, but the defaults it
uses are less than desirable (in fact, they are worse than random
typing - a infinite number of monkeys typing into GNU emacs would never
make a good program). 

So, you can either get rid of GNU emacs, or change it to use saner
values.  To do the latter, you can stick the following in your .emacs file:

(defun linux-c-mode ()
  "C mode with adjusted defaults for use with the Linux kernel."
  (interactive)
  (c-mode)
  (c-set-style "K&R")
  (setq c-basic-offset 8))

This will define the M-x linux-c-mode command.  When hacking on a
module, if you put the string -*- linux-c -*- somewhere on the first
two lines, this mode will be automatically invoked. Also, you may want
to add

(setq auto-mode-alist (cons '("/usr/src/linux.*/.*\\.[ch]$" . linux-c-mode)
                       auto-mode-alist))

to your .emacs file if you want to have linux-c-mode switched on
automagically when you edit source files under /usr/src/linux.

But even if you fail in getting emacs to do sane formatting, not
everything is lost: use "indent".

Now, again, GNU indent has the same brain dead settings that GNU emacs
has, which is why you need to give it a few command line options. 
However, that's not too bad, because even the makers of GNU indent
recognize the authority of K&R (the GNU people aren't evil, they are
just severely misguided in this matter), so you just give indent the
options "-kr -i8" (stands for "K&R, 8 character indents"). 

"indent" has a lot of options, and especially when it comes to comment
re-formatting you may want to take a look at the manual page.  But
remember: "indent" is not a fix for bad programming.