Initial Ccheckin of prozilla 2.0.4
This commit is contained in:
Mario Fetka
198
libprozilla/docs/HACKING
Normal file
198
libprozilla/docs/HACKING
Normal file
@@ -0,0 +1,198 @@
|
||||
-------------------------------------------------------------------------------
|
||||
Information for developers and contributors
|
||||
-------------------------------------------------------------------------------
|
||||
|
||||
This documentation shall give some hints to developers and contributors.
|
||||
Please send comments and suggestions to the prozilla-dev mailinglist.
|
||||
|
||||
|
||||
Coding guidelines
|
||||
-----------------
|
||||
|
||||
* Use an indentation width of 2 spaces.
|
||||
Braces are put on a separate line, not on the same line as the
|
||||
if/while/for etc. statements. The braces themselves are not indented, only
|
||||
the code within the braces.
|
||||
|
||||
Example:
|
||||
|
||||
if (foo == TRUE)
|
||||
{
|
||||
while (bar != NULL)
|
||||
{
|
||||
do_something("Test.", 19);
|
||||
do_something_else();
|
||||
}
|
||||
}
|
||||
else
|
||||
{
|
||||
printf("Foo is not TRUE.\n");
|
||||
exit(EXIT_SUCCESS);
|
||||
}
|
||||
|
||||
* Put a space after each comma.
|
||||
|
||||
* Do *not* put spaces between the function-name and the opening brace:
|
||||
Wrong: foo ("Test", 19);
|
||||
Correct: foo("Test", 19);
|
||||
|
||||
* Do not put a space when referring to a pointer.
|
||||
Wrong: void foo(const char * message);
|
||||
Correct: void foo(const char *message);
|
||||
|
||||
* Do not use any TABs in the code. The only files where you should use TABs
|
||||
is the ChangeLog and the Makefile.am's.
|
||||
|
||||
* Write only 80 characters per line where possible.
|
||||
|
||||
Have a look at the already existing code for examples.
|
||||
|
||||
|
||||
Names
|
||||
-----
|
||||
|
||||
Always use good, unabbreviated, correctly-spelled meaningful names.
|
||||
|
||||
All functions, variables, enums, #defines etc. which are intended to be used
|
||||
by the programs which link against libprozilla, are prefixed with proz_
|
||||
or PROZ_.
|
||||
|
||||
Examples:
|
||||
proz_init();
|
||||
#define PROZ_MAX_CONNECTIONS 19
|
||||
etc.
|
||||
|
||||
|
||||
TODO, FIXME and NOTE
|
||||
--------------------
|
||||
|
||||
Use the keywords 'TODO', 'FIXME' and 'NOTE' in the source-code comments
|
||||
to remind yourself or other developers of things which still need to be
|
||||
done or fixed.
|
||||
|
||||
You can then do a simple 'grep TODO *.[ch]' to find all those comments...
|
||||
|
||||
|
||||
ChangeLog entries
|
||||
-----------------
|
||||
|
||||
Everytime you make a change to any of the files, you must write a ChangeLog
|
||||
entry with your name, email adress and the date. Please try to write
|
||||
verbosive comments and also give reasons why you wrote/changed something
|
||||
if that reason is not obvious...
|
||||
|
||||
You can use 'cvs -z3 diff -Nu * | vim -' to view the differences between your
|
||||
code and the latest CVS-code. Use this as a help to write the ChangeLog entry.
|
||||
|
||||
Changes to the file 'ChangeLog' can be omitted, because this file is changed
|
||||
*everytime* anyway...
|
||||
|
||||
If you commit a patch from another developer or a contributor, add his name
|
||||
and email-adress to the file AUTHORS. Also write a small message in the
|
||||
ChangeLog which says e.g. 'Applied patch from Joe Foo <foo@bar.com>.'.
|
||||
|
||||
Do the same if someone reports and/or fixes a bug: Add him to AUTHORS and add
|
||||
a ChangeLog entry, e.g. 'Fixed a bug reported by Joe Foo <foo@bar.com>.'.
|
||||
|
||||
|
||||
Comments
|
||||
--------
|
||||
|
||||
* Do not comment obvious code (i++ /* Increment i. */ etc...).
|
||||
|
||||
* Only use C-style comments (/* Foo. */) and not C++-style comments (// Foo.).
|
||||
|
||||
* All comments should start with a capital letter and end with a dot.
|
||||
|
||||
|
||||
Tools used
|
||||
----------
|
||||
|
||||
We use the following tools for this project:
|
||||
|
||||
* autoconf 2.13 or better
|
||||
ftp://ftp.gnu.org/gnu/autoconf/
|
||||
|
||||
* automake 1.4 or better
|
||||
ftp://ftp.gnu.org/gnu/automake/
|
||||
|
||||
|
||||
Code from other projects
|
||||
------------------------
|
||||
|
||||
* getopt.c, getopt.h:
|
||||
Purpose: Commandline options parsing code.
|
||||
Author: ???
|
||||
License: GPL.
|
||||
From: ftp://ftp.gnu.org/gnu/glibc/
|
||||
Comments: Unmodified version from glibc.
|
||||
|
||||
* netrc.c, netrc.h:
|
||||
Purpose: Parse the .netrc file to get hosts, accounts, and passwords.
|
||||
Author: Gordon Matzigkeit <gord@gnu.ai.mit.edu>
|
||||
License: GPL
|
||||
From: ???
|
||||
Comments: Modified for libprozilla.
|
||||
|
||||
* url.c, url.h:
|
||||
Purpose: URL handling code.
|
||||
Author: ???
|
||||
License: GPL.
|
||||
From: ???
|
||||
Comments: Modified for libprozilla.
|
||||
|
||||
|
||||
Automatically generated files
|
||||
-----------------------------
|
||||
|
||||
The following files are automatically generated by either aclocal, autoheader
|
||||
autoconf or automake. Do not edit them directly.
|
||||
|
||||
Makefile.in
|
||||
aclocal.m4
|
||||
config.h.in
|
||||
configure
|
||||
install-sh
|
||||
missing
|
||||
mkinstalldirs
|
||||
stamp-h.in
|
||||
docs/Makefile.in
|
||||
src/Makefile.in
|
||||
|
||||
|
||||
common.h
|
||||
--------
|
||||
|
||||
All libprozilla files include the common.h file. This file #includes all
|
||||
headers we need, #defines some things like TRUE and FALSE, typedefs
|
||||
a 'boolean' type etc...
|
||||
|
||||
|
||||
Patches
|
||||
-------
|
||||
|
||||
Send your patches (diff -u) to the prozilla-dev mailinglist.
|
||||
|
||||
If you changed several things in the code or fixed more than one problem,
|
||||
please send a separate patch for each of the fixes. If everything is in one
|
||||
single patch file, the patch is a lot harder to understand, check and apply.
|
||||
|
||||
|
||||
Mailinglists
|
||||
------------
|
||||
|
||||
Read the README.
|
||||
|
||||
|
||||
CVS
|
||||
---
|
||||
|
||||
You can access the libprozilla CVS repository anonymously (read-only access)
|
||||
by issueing the following commands:
|
||||
|
||||
cvs -d :pserver:anonymous@cvs.delrom.ro:/home/cvsroot login
|
||||
|
||||
Press enter when prompted for the password.
|
||||
|
||||
cvs -d :pserver:anonymous@cvs.delrom.ro:/home/cvsroot co libprozilla
|
||||
|
||||
6
libprozilla/docs/Makefile.am
Normal file
6
libprozilla/docs/Makefile.am
Normal file
@@ -0,0 +1,6 @@
|
||||
#------------------------------------------------------------------------------
|
||||
# Process this file with automake to produce Makefile.in.
|
||||
#------------------------------------------------------------------------------
|
||||
|
||||
EXTRA_DIST = HACKING
|
||||
|
||||
211
libprozilla/docs/Makefile.in
Normal file
211
libprozilla/docs/Makefile.in
Normal file
@@ -0,0 +1,211 @@
|
||||
# Makefile.in generated automatically by automake 1.4-p6 from Makefile.am
|
||||
|
||||
# Copyright (C) 1994, 1995-8, 1999, 2001 Free Software Foundation, Inc.
|
||||
# This Makefile.in is free software; the Free Software Foundation
|
||||
# gives unlimited permission to copy and/or distribute it,
|
||||
# with or without modifications, as long as this notice is preserved.
|
||||
|
||||
# This program is distributed in the hope that it will be useful,
|
||||
# but WITHOUT ANY WARRANTY, to the extent permitted by law; without
|
||||
# even the implied warranty of MERCHANTABILITY or FITNESS FOR A
|
||||
# PARTICULAR PURPOSE.
|
||||
|
||||
#------------------------------------------------------------------------------
|
||||
# Process this file with automake to produce Makefile.in.
|
||||
#------------------------------------------------------------------------------
|
||||
|
||||
|
||||
SHELL = @SHELL@
|
||||
|
||||
srcdir = @srcdir@
|
||||
top_srcdir = @top_srcdir@
|
||||
VPATH = @srcdir@
|
||||
prefix = @prefix@
|
||||
exec_prefix = @exec_prefix@
|
||||
|
||||
bindir = @bindir@
|
||||
sbindir = @sbindir@
|
||||
libexecdir = @libexecdir@
|
||||
datadir = @datadir@
|
||||
sysconfdir = @sysconfdir@
|
||||
sharedstatedir = @sharedstatedir@
|
||||
localstatedir = @localstatedir@
|
||||
libdir = @libdir@
|
||||
infodir = @infodir@
|
||||
mandir = @mandir@
|
||||
includedir = @includedir@
|
||||
oldincludedir = /usr/include
|
||||
|
||||
DESTDIR =
|
||||
|
||||
pkgdatadir = $(datadir)/@PACKAGE@
|
||||
pkglibdir = $(libdir)/@PACKAGE@
|
||||
pkgincludedir = $(includedir)/@PACKAGE@
|
||||
|
||||
top_builddir = ..
|
||||
|
||||
ACLOCAL = @ACLOCAL@
|
||||
AUTOCONF = @AUTOCONF@
|
||||
AUTOMAKE = @AUTOMAKE@
|
||||
AUTOHEADER = @AUTOHEADER@
|
||||
|
||||
INSTALL = @INSTALL@
|
||||
INSTALL_PROGRAM = @INSTALL_PROGRAM@ $(AM_INSTALL_PROGRAM_FLAGS)
|
||||
INSTALL_DATA = @INSTALL_DATA@
|
||||
INSTALL_SCRIPT = @INSTALL_SCRIPT@
|
||||
transform = @program_transform_name@
|
||||
|
||||
NORMAL_INSTALL = :
|
||||
PRE_INSTALL = :
|
||||
POST_INSTALL = :
|
||||
NORMAL_UNINSTALL = :
|
||||
PRE_UNINSTALL = :
|
||||
POST_UNINSTALL = :
|
||||
host_alias = @host_alias@
|
||||
host_triplet = @host@
|
||||
AS = @AS@
|
||||
BUILD_INCLUDED_LIBINTL = @BUILD_INCLUDED_LIBINTL@
|
||||
CATALOGS = @CATALOGS@
|
||||
CATOBJEXT = @CATOBJEXT@
|
||||
CC = @CC@
|
||||
DATADIRNAME = @DATADIRNAME@
|
||||
DLLTOOL = @DLLTOOL@
|
||||
GENCAT = @GENCAT@
|
||||
GLIBC21 = @GLIBC21@
|
||||
GMOFILES = @GMOFILES@
|
||||
GMSGFMT = @GMSGFMT@
|
||||
HAVE_LIB = @HAVE_LIB@
|
||||
INSTOBJEXT = @INSTOBJEXT@
|
||||
INTLBISON = @INTLBISON@
|
||||
INTLLIBS = @INTLLIBS@
|
||||
INTLOBJS = @INTLOBJS@
|
||||
INTL_LIBTOOL_SUFFIX_PREFIX = @INTL_LIBTOOL_SUFFIX_PREFIX@
|
||||
LIB = @LIB@
|
||||
LIBICONV = @LIBICONV@
|
||||
LIBTOOL = @LIBTOOL@
|
||||
LN_S = @LN_S@
|
||||
LTLIB = @LTLIB@
|
||||
MAKEINFO = @MAKEINFO@
|
||||
MKINSTALLDIRS = @MKINSTALLDIRS@
|
||||
MSGFMT = @MSGFMT@
|
||||
MSGMERGE = @MSGMERGE@
|
||||
OBJDUMP = @OBJDUMP@
|
||||
PACKAGE = @PACKAGE@
|
||||
POFILES = @POFILES@
|
||||
POSUB = @POSUB@
|
||||
RANLIB = @RANLIB@
|
||||
THREAD_LIBS = @THREAD_LIBS@
|
||||
USE_INCLUDED_LIBINTL = @USE_INCLUDED_LIBINTL@
|
||||
USE_NLS = @USE_NLS@
|
||||
VERSION = @VERSION@
|
||||
XGETTEXT = @XGETTEXT@
|
||||
|
||||
EXTRA_DIST = HACKING
|
||||
mkinstalldirs = $(SHELL) $(top_srcdir)/mkinstalldirs
|
||||
CONFIG_HEADER = ../config.h
|
||||
CONFIG_CLEAN_FILES =
|
||||
DIST_COMMON = Makefile.am Makefile.in
|
||||
|
||||
|
||||
DISTFILES = $(DIST_COMMON) $(SOURCES) $(HEADERS) $(TEXINFOS) $(EXTRA_DIST)
|
||||
|
||||
TAR = tar
|
||||
GZIP_ENV = --best
|
||||
all: all-redirect
|
||||
.SUFFIXES:
|
||||
$(srcdir)/Makefile.in: Makefile.am $(top_srcdir)/configure.in $(ACLOCAL_M4)
|
||||
cd $(top_srcdir) && $(AUTOMAKE) --gnu docs/Makefile
|
||||
|
||||
Makefile: $(srcdir)/Makefile.in $(top_builddir)/config.status $(BUILT_SOURCES)
|
||||
cd $(top_builddir) \
|
||||
&& CONFIG_FILES=$(subdir)/$@ CONFIG_HEADERS= $(SHELL) ./config.status
|
||||
|
||||
tags: TAGS
|
||||
TAGS:
|
||||
|
||||
|
||||
distdir = $(top_builddir)/$(PACKAGE)-$(VERSION)/$(subdir)
|
||||
|
||||
subdir = docs
|
||||
|
||||
distdir: $(DISTFILES)
|
||||
here=`cd $(top_builddir) && pwd`; \
|
||||
top_distdir=`cd $(top_distdir) && pwd`; \
|
||||
distdir=`cd $(distdir) && pwd`; \
|
||||
cd $(top_srcdir) \
|
||||
&& $(AUTOMAKE) --include-deps --build-dir=$$here --srcdir-name=$(top_srcdir) --output-dir=$$top_distdir --gnu docs/Makefile
|
||||
@for file in $(DISTFILES); do \
|
||||
d=$(srcdir); \
|
||||
if test -d $$d/$$file; then \
|
||||
cp -pr $$d/$$file $(distdir)/$$file; \
|
||||
else \
|
||||
test -f $(distdir)/$$file \
|
||||
|| ln $$d/$$file $(distdir)/$$file 2> /dev/null \
|
||||
|| cp -p $$d/$$file $(distdir)/$$file || :; \
|
||||
fi; \
|
||||
done
|
||||
info-am:
|
||||
info: info-am
|
||||
dvi-am:
|
||||
dvi: dvi-am
|
||||
check-am: all-am
|
||||
check: check-am
|
||||
installcheck-am:
|
||||
installcheck: installcheck-am
|
||||
install-exec-am:
|
||||
install-exec: install-exec-am
|
||||
|
||||
install-data-am:
|
||||
install-data: install-data-am
|
||||
|
||||
install-am: all-am
|
||||
@$(MAKE) $(AM_MAKEFLAGS) install-exec-am install-data-am
|
||||
install: install-am
|
||||
uninstall-am:
|
||||
uninstall: uninstall-am
|
||||
all-am: Makefile
|
||||
all-redirect: all-am
|
||||
install-strip:
|
||||
$(MAKE) $(AM_MAKEFLAGS) AM_INSTALL_PROGRAM_FLAGS=-s install
|
||||
installdirs:
|
||||
|
||||
|
||||
mostlyclean-generic:
|
||||
|
||||
clean-generic:
|
||||
|
||||
distclean-generic:
|
||||
-rm -f Makefile $(CONFIG_CLEAN_FILES)
|
||||
-rm -f config.cache config.log stamp-h stamp-h[0-9]*
|
||||
|
||||
maintainer-clean-generic:
|
||||
mostlyclean-am: mostlyclean-generic
|
||||
|
||||
mostlyclean: mostlyclean-am
|
||||
|
||||
clean-am: clean-generic mostlyclean-am
|
||||
|
||||
clean: clean-am
|
||||
|
||||
distclean-am: distclean-generic clean-am
|
||||
-rm -f libtool
|
||||
|
||||
distclean: distclean-am
|
||||
|
||||
maintainer-clean-am: maintainer-clean-generic distclean-am
|
||||
@echo "This command is intended for maintainers to use;"
|
||||
@echo "it deletes files that may require special tools to rebuild."
|
||||
|
||||
maintainer-clean: maintainer-clean-am
|
||||
|
||||
.PHONY: tags distdir info-am info dvi-am dvi check check-am \
|
||||
installcheck-am installcheck install-exec-am install-exec \
|
||||
install-data-am install-data install-am install uninstall-am uninstall \
|
||||
all-redirect all-am all installdirs mostlyclean-generic \
|
||||
distclean-generic clean-generic maintainer-clean-generic clean \
|
||||
mostlyclean distclean maintainer-clean
|
||||
|
||||
|
||||
# Tell versions [3.59,3.63) of GNU make to not export all variables.
|
||||
# Otherwise a system limit (for SysV at least) may be exceeded.
|
||||
.NOEXPORT:
|
||||
Reference in New Issue
Block a user