GothenburgBitFactory/taskwarrior
1
0
Fork 0
mirror of https://github.com/GothenburgBitFactory/taskwarrior.git synced 2025-06-26 10:54:26 +02:00
Code Issues Projects Releases Packages Wiki Activity Actions 1

Documentation

Browse source 
- Updated the INSTALL file to discuss cmake, not autoconf.
- Removed the transient test/Makefile from git.
This commit is contained in:
Paul Beckingham 2010-12-29 16:48:54 -05:00
parent 429709a426
commit 552c594d3f
2 changed files with 42 additions and 336 deletions
Download patch file Download diff file Expand all files Collapse all files

251
INSTALL
View file

@ -1,5 +1,5 @@
Installation Instructions Installation Instructions
************************* -------------------------
Copyright (C) 1994, 1995, 1996, 1999, 2000, 2001, 2002, 2004, 2005, Copyright (C) 1994, 1995, 1996, 1999, 2000, 2001, 2002, 2004, 2005,
2006 Free Software Foundation, Inc. 2006 Free Software Foundation, Inc.
@ -7,228 +7,61 @@ Copyright (C) 1994, 1995, 1996, 1999, 2000, 2001, 2002, 2004, 2005,
This file is free documentation; the Free Software Foundation gives This file is free documentation; the Free Software Foundation gives
unlimited permission to copy, distribute and modify it. unlimited permission to copy, distribute and modify it.
Pre-requisites
--------------
You will need the 'cmake' build system installed in order to build taskwarrior
from source.
Optionally, you might want to have Lua installed, if you wish to write plugins
and modify taskwarrior.
Basic Installation Basic Installation
================== ------------------
Briefly, the shell commands `./configure; make; make install' should Briefly, these shell commands will unpack, build and install taskwarrior:
configure, build, and install this package. The following
more-detailed instructions are generic; see the `README' file for
instructions specific to this package.
The `configure' shell script attempts to guess correct values for $ tar xzf task-X.Y.Z.tar.gz [1]
various system-dependent variables used during compilation. It uses $ cd task-X.Y.Z [2]
those values to create a `Makefile' in each directory of the package. $ cmake . [3]
It may also create one or more `.h' files containing system-dependent $ make [4]
definitions. Finally, it creates a shell script `config.status' that $ make test [5]
you can run in the future to recreate the current configuration, and a $ sudo make install [6]
file `config.log' containing compiler output (useful mainly for $ cd .. ; rm -r task-X.Y.Z [7]
debugging `configure').
It can also use an optional file (typically called `config.cache' These commands are explained below:
and enabled with `--cache-file=config.cache' or simply `-C') that saves
the results of its tests to speed up reconfiguring. Caching is
disabled by default to prevent problems with accidental use of stale
cache files.
If you need to do unusual things to compile the package, please try 1. Unpacks the source tarball. This creates the directory task-X.Y.Z,
to figure out how `configure' could check whether to do them, and mail containing all the code.
diffs or instructions to the address given in the `README' so they can
be considered for the next release. If you are using the cache, and at
some point `config.cache' contains results you don't want to keep, you
may remove or edit it.
The file `configure.ac' (or `configure.in') is used to create 2. Change directory to the root of the distribution.
`configure' by a program called `autoconf'. You need `configure.ac' if
you want to change it or regenerate `configure' using a newer version
of `autoconf'.
The simplest way to compile this package is: 3. Invokes cmake to scan for dependencies and machine-specific details, then
generate the makefiles. This may take a minute.
1. `cd' to the directory containing the package's source code and type 4. Builds taskwarrior. This may take a minute.
`./configure' to configure the package for your system.
Running `configure' might take a while. While running, it prints 5. Optional step that runs the unit tests. This will take several minutes,
some messages telling which features it is checking for. during which there will be minimal feedback. Note that thousands of tests
are run, and some of those tests need to introduce a delay between commands
which explains the lengthy time. On completion, will report the number of
passing and failing tests. There should be zero failing tests.
2. Type `make' to compile the package. 6. Installs the program, documentation and other data files.
3. Optionally, type `make check' to run any self-tests that come with 7. Removes the temporary directory.
the package.
4. Type `make install' to install the programs and any data files and
documentation.
5. You can remove the program binaries and object files from the Uninstallation
source code directory by typing `make clean'. To also remove the --------------
files that `configure' created (so you can compile the package for
a different kind of computer), type `make distclean'. There is
also a `make maintainer-clean' target, but that is intended mainly
for the package's developers. If you use it, you may have to get
all sorts of other programs in order to regenerate files that came
with the distribution.
Compilers and Options To uninstall taskwarrior, you need the Makefiles, so if you deleted them in
===================== step 7 above, they must first be regenerated by following steps [1], [2] and
[3]. Then simply run:
Some systems require unusual options for compilation or linking that the $ sudo make uninstall
`configure' script does not know about. Run `./configure --help' for
details on some of the pertinent environment variables.
You can give `configure' initial values for configuration parameters ---
by setting variables in the command line or in the environment. Here
is an example:
./configure CC=c99 CFLAGS=-g LIBS=-lposix
*Note Defining Variables::, for more details.
Compiling For Multiple Architectures
====================================
You can compile the package for more than one kind of computer at the
same time, by placing the object files for each architecture in their
own directory. To do this, you can use GNU `make'. `cd' to the
directory where you want the object files and executables to go and run
the `configure' script. `configure' automatically checks for the
source code in the directory that `configure' is in and in `..'.
With a non-GNU `make', it is safer to compile the package for one
architecture at a time in the source code directory. After you have
installed the package for one architecture, use `make distclean' before
reconfiguring for another architecture.
Installation Names
==================
By default, `make install' installs the package's commands under
`/usr/local/bin', include files under `/usr/local/include', etc. You
can specify an installation prefix other than `/usr/local' by giving
`configure' the option `--prefix=PREFIX'.
You can specify separate installation prefixes for
architecture-specific files and architecture-independent files. If you
pass the option `--exec-prefix=PREFIX' to `configure', the package uses
PREFIX as the prefix for installing programs and libraries.
Documentation and other data files still use the regular prefix.
In addition, if you use an unusual directory layout you can give
options like `--bindir=DIR' to specify different values for particular
kinds of files. Run `configure --help' for a list of the directories
you can set and what kinds of files go in them.
If the package supports it, you can cause programs to be installed
with an extra prefix or suffix on their names by giving `configure' the
option `--program-prefix=PREFIX' or `--program-suffix=SUFFIX'.
Optional Features
=================
Some packages pay attention to `--enable-FEATURE' options to
`configure', where FEATURE indicates an optional part of the package.
They may also pay attention to `--with-PACKAGE' options, where PACKAGE
is something like `gnu-as' or `x' (for the X Window System). The
`README' should mention any `--enable-' and `--with-' options that the
package recognizes.
For packages that use the X Window System, `configure' can usually
find the X include and library files automatically, but if it doesn't,
you can use the `configure' options `--x-includes=DIR' and
`--x-libraries=DIR' to specify their locations.
Specifying the System Type
==========================
There may be some features `configure' cannot figure out automatically,
but needs to determine by the type of machine the package will run on.
Usually, assuming the package is built to be run on the _same_
architectures, `configure' can figure that out, but if it prints a
message saying it cannot guess the machine type, give it the
`--build=TYPE' option. TYPE can either be a short name for the system
type, such as `sun4', or a canonical name which has the form:
CPU-COMPANY-SYSTEM
where SYSTEM can have one of these forms:
OS KERNEL-OS
See the file `config.sub' for the possible values of each field. If
`config.sub' isn't included in this package, then this package doesn't
need to know the machine type.
If you are _building_ compiler tools for cross-compiling, you should
use the option `--target=TYPE' to select the type of system they will
produce code for.
If you want to _use_ a cross compiler, that generates code for a
platform different from the build platform, you should specify the
"host" platform (i.e., that on which the generated programs will
eventually be run) with `--host=TYPE'.
Sharing Defaults
================
If you want to set default values for `configure' scripts to share, you
can create a site shell script called `config.site' that gives default
values for variables like `CC', `cache_file', and `prefix'.
`configure' looks for `PREFIX/share/config.site' if it exists, then
`PREFIX/etc/config.site' if it exists. Or, you can set the
`CONFIG_SITE' environment variable to the location of the site script.
A warning: not all `configure' scripts look for a site script.
Defining Variables
==================
Variables not defined in a site shell script can be set in the
environment passed to `configure'. However, some packages may run
configure again during the build, and the customized values of these
variables may be lost. In order to avoid this problem, you should set
them in the `configure' command line, using `VAR=value'. For example:
./configure CC=/usr/local2/bin/gcc
causes the specified `gcc' to be used as the C compiler (unless it is
overridden in the site shell script).
Unfortunately, this technique does not work for `CONFIG_SHELL' due to
an Autoconf bug. Until the bug is fixed you can use this workaround:
CONFIG_SHELL=/bin/bash /bin/bash ./configure CONFIG_SHELL=/bin/bash
`configure' Invocation
======================
`configure' recognizes the following options to control how it operates.
`--help'
`-h'
Print a summary of the options to `configure', and exit.
`--version'
`-V'
Print the version of Autoconf used to generate the `configure'
script, and exit.
`--cache-file=FILE'
Enable the cache: use and save the results of the tests in FILE,
traditionally `config.cache'. FILE defaults to `/dev/null' to
disable caching.
`--config-cache'
`-C'
Alias for `--cache-file=config.cache'.
`--quiet'
`--silent'
`-q'
Do not print messages saying which checks are being made. To
suppress all normal output, redirect it to `/dev/null' (any error
messages will still be shown).
`--srcdir=DIR'
Look for the package's source code in directory DIR. Usually
`configure' can determine that directory automatically.
`configure' also accepts some other, not widely useful, options. Run
`configure --help' for more details.

127
test/Makefile
View file

@ -1,127 +0,0 @@
PROJECT = t.t tdb.t date.t duration.t t.benchmark.t text.t autocomplete.t \
config.t seq.t att.t stringtable.t record.t nibbler.t subst.t filt.t \
cmd.t util.t color.t list.t path.t file.t directory.t grid.t rx.t \
taskmod.t sensor.t rectangle.t tree.t tree2.t lisp.t uri.t
CFLAGS = -I. -I.. -I../src -Wall -pedantic -ggdb3 -fno-rtti
LFLAGS = -L/usr/local/lib -lpthread -llua
OBJECTS = ../src/t-TDB.o ../src/t-Task.o ../src/t-text.o ../src/t-Date.o ../src/t-Table.o \
../src/t-Duration.o ../src/t-util.o ../src/t-Config.o ../src/t-Sequence.o ../src/t-Att.o \
../src/t-Cmd.o ../src/t-Record.o ../src/t-StringTable.o ../src/t-Subst.o \
../src/t-Nibbler.o ../src/t-Location.o ../src/t-Filter.o ../src/t-Context.o \
../src/t-Keymap.o ../src/t-command.o ../src/t-interactive.o ../src/t-report.o \
../src/t-Grid.o ../src/t-Color.o ../src/t-rules.o ../src/t-recur.o ../src/t-custom.o \
../src/t-export.o ../src/t-import.o ../src/t-edit.o ../src/t-Timer.o \
../src/t-Permission.o ../src/t-Path.o ../src/t-File.o ../src/t-Directory.o \
../src/t-Hooks.o ../src/t-API.o ../src/t-rx.o ../src/t-Taskmod.o ../src/t-dependency.o \
../src/t-Transport.o ../src/t-TransportSSH.o ../src/t-Sensor.o ../src/t-Thread.o \
../src/t-Lisp.o ../src/t-Rectangle.o ../src/t-Tree.o ../src/t-TransportRSYNC.o \
../src/t-TransportCurl.o ../src/t-Uri.o ../src/t-diag.o ../src/t-burndown.o \
../src/t-history.o
all: $(PROJECT)
install: $(PROJECT)
@echo unimplemented
test: $(PROJECT)
@echo unimplemented
clean:
-rm *.o $(PROJECT)
.cpp.o:
g++ -c $(CFLAGS) $<
t.t: t.t.o $(OBJECTS) test.o
g++ t.t.o $(OBJECTS) test.o $(LFLAGS) -o t.t
tdb.t: tdb.t.o $(OBJECTS) test.o
g++ tdb.t.o $(OBJECTS) test.o $(LFLAGS) -o tdb.t
date.t: date.t.o $(OBJECTS) test.o
g++ date.t.o $(OBJECTS) test.o $(LFLAGS) -o date.t
duration.t: duration.t.o $(OBJECTS) test.o
g++ duration.t.o $(OBJECTS) test.o $(LFLAGS) -o duration.t
t.benchmark.t: t.benchmark.t.o $(OBJECTS) test.o
g++ t.benchmark.t.o $(OBJECTS) test.o $(LFLAGS) -o t.benchmark.t
text.t: text.t.o $(OBJECTS) test.o
g++ text.t.o $(OBJECTS) test.o $(LFLAGS) -o text.t
autocomplete.t: autocomplete.t.o $(OBJECTS) test.o
g++ autocomplete.t.o $(OBJECTS) test.o $(LFLAGS) -o autocomplete.t
seq.t: seq.t.o $(OBJECTS) test.o
g++ seq.t.o $(OBJECTS) test.o $(LFLAGS) -o seq.t
record.t: record.t.o $(OBJECTS) test.o
g++ record.t.o $(OBJECTS) test.o $(LFLAGS) -o record.t
att.t: att.t.o $(OBJECTS) test.o
g++ att.t.o $(OBJECTS) test.o $(LFLAGS) -o att.t
stringtable.t: stringtable.t.o $(OBJECTS) test.o
g++ stringtable.t.o $(OBJECTS) test.o $(LFLAGS) -o stringtable.t
subst.t: subst.t.o $(OBJECTS) test.o
g++ subst.t.o $(OBJECTS) test.o $(LFLAGS) -o subst.t
nibbler.t: nibbler.t.o $(OBJECTS) test.o
g++ nibbler.t.o $(OBJECTS) test.o $(LFLAGS) -o nibbler.t
filt.t: filt.t.o $(OBJECTS) test.o
g++ filt.t.o $(OBJECTS) test.o $(LFLAGS) -o filt.t
cmd.t: cmd.t.o $(OBJECTS) test.o
g++ cmd.t.o $(OBJECTS) test.o $(LFLAGS) -o cmd.t
config.t: config.t.o $(OBJECTS) test.o
g++ config.t.o $(OBJECTS) test.o $(LFLAGS) -o config.t
util.t: util.t.o $(OBJECTS) test.o
g++ util.t.o $(OBJECTS) test.o $(LFLAGS) -o util.t
color.t: color.t.o $(OBJECTS) test.o
g++ color.t.o $(OBJECTS) test.o $(LFLAGS) -o color.t
list.t: list.t.o $(OBJECTS) test.o
g++ list.t.o $(OBJECTS) test.o $(LFLAGS) -o list.t
path.t: path.t.o $(OBJECTS) test.o
g++ path.t.o $(OBJECTS) test.o $(LFLAGS) -o path.t
file.t: file.t.o $(OBJECTS) test.o
g++ file.t.o $(OBJECTS) test.o $(LFLAGS) -o file.t
directory.t: directory.t.o $(OBJECTS) test.o
g++ directory.t.o $(OBJECTS) test.o $(LFLAGS) -o directory.t
grid.t: grid.t.o $(OBJECTS) test.o
g++ grid.t.o $(OBJECTS) test.o $(LFLAGS) -o grid.t
rx.t: rx.t.o $(OBJECTS) test.o
g++ rx.t.o $(OBJECTS) test.o $(LFLAGS) -o rx.t
taskmod.t: taskmod.t.o $(OBJECTS) test.o
g++ taskmod.t.o $(OBJECTS) test.o $(LFLAGS) -o taskmod.t
lisp.t: lisp.t.o $(OBJECTS) test.o
g++ lisp.t.o $(OBJECTS) test.o $(LFLAGS) -o lisp.t
rectangle.t: rectangle.t.o $(OBJECTS) test.o
g++ rectangle.t.o $(OBJECTS) test.o $(LFLAGS) -o rectangle.t
sensor.t: sensor.t.o $(OBJECTS) test.o
g++ sensor.t.o $(OBJECTS) test.o $(LFLAGS) -o sensor.t
tree.t: tree.t.o $(OBJECTS) test.o
g++ tree.t.o $(OBJECTS) test.o $(LFLAGS) -o tree.t
tree2.t: tree2.t.o $(OBJECTS) test.o
g++ tree2.t.o $(OBJECTS) test.o $(LFLAGS) -o tree2.t
uri.t: uri.t.o $(OBJECTS) test.o
g++ uri.t.o $(OBJECTS) test.o $(LFLAGS) -o uri.t