documentation/Makefile
author Florian Pose <fp@igh-essen.com>
Mon, 28 Jul 2008 11:29:28 +0000
changeset 1157 04d1c950cf9d
parent 1140 cc779f7d2496
child 1202 91d190223daa
permissions -rw-r--r--
Added --help for alias and position parameters.
369
7920ca086e5c Moved doc into trunk
Florian Pose <fp@igh-essen.com>
parents:
diff changeset
     1
#------------------------------------------------------------------------------
7920ca086e5c Moved doc into trunk
Florian Pose <fp@igh-essen.com>
parents:
diff changeset
     2
#
7920ca086e5c Moved doc into trunk
Florian Pose <fp@igh-essen.com>
parents:
diff changeset
     3
#  LaTeX Makefile
7920ca086e5c Moved doc into trunk
Florian Pose <fp@igh-essen.com>
parents:
diff changeset
     4
#
7920ca086e5c Moved doc into trunk
Florian Pose <fp@igh-essen.com>
parents:
diff changeset
     5
#  $Id$
7920ca086e5c Moved doc into trunk
Florian Pose <fp@igh-essen.com>
parents:
diff changeset
     6
#
7920ca086e5c Moved doc into trunk
Florian Pose <fp@igh-essen.com>
parents:
diff changeset
     7
#------------------------------------------------------------------------------
7920ca086e5c Moved doc into trunk
Florian Pose <fp@igh-essen.com>
parents:
diff changeset
     8
7920ca086e5c Moved doc into trunk
Florian Pose <fp@igh-essen.com>
parents:
diff changeset
     9
FILE := ethercat_doc
7920ca086e5c Moved doc into trunk
Florian Pose <fp@igh-essen.com>
parents:
diff changeset
    10
7920ca086e5c Moved doc into trunk
Florian Pose <fp@igh-essen.com>
parents:
diff changeset
    11
LATEX_OPTIONS := -file-line-error-style
7920ca086e5c Moved doc into trunk
Florian Pose <fp@igh-essen.com>
parents:
diff changeset
    12
1140
cc779f7d2496 Command-line help in the docs.
Florian Pose <fp@igh-essen.com>
parents: 371
diff changeset
    13
COMMANDS := \
cc779f7d2496 Command-line help in the docs.
Florian Pose <fp@igh-essen.com>
parents: 371
diff changeset
    14
	alias \
cc779f7d2496 Command-line help in the docs.
Florian Pose <fp@igh-essen.com>
parents: 371
diff changeset
    15
	config \
cc779f7d2496 Command-line help in the docs.
Florian Pose <fp@igh-essen.com>
parents: 371
diff changeset
    16
	data \
cc779f7d2496 Command-line help in the docs.
Florian Pose <fp@igh-essen.com>
parents: 371
diff changeset
    17
	debug \
cc779f7d2496 Command-line help in the docs.
Florian Pose <fp@igh-essen.com>
parents: 371
diff changeset
    18
	domains \
cc779f7d2496 Command-line help in the docs.
Florian Pose <fp@igh-essen.com>
parents: 371
diff changeset
    19
	master \
cc779f7d2496 Command-line help in the docs.
Florian Pose <fp@igh-essen.com>
parents: 371
diff changeset
    20
	pdos \
cc779f7d2496 Command-line help in the docs.
Florian Pose <fp@igh-essen.com>
parents: 371
diff changeset
    21
	sdos \
cc779f7d2496 Command-line help in the docs.
Florian Pose <fp@igh-essen.com>
parents: 371
diff changeset
    22
	download \
cc779f7d2496 Command-line help in the docs.
Florian Pose <fp@igh-essen.com>
parents: 371
diff changeset
    23
	upload \
cc779f7d2496 Command-line help in the docs.
Florian Pose <fp@igh-essen.com>
parents: 371
diff changeset
    24
	slaves \
cc779f7d2496 Command-line help in the docs.
Florian Pose <fp@igh-essen.com>
parents: 371
diff changeset
    25
	sii_read \
cc779f7d2496 Command-line help in the docs.
Florian Pose <fp@igh-essen.com>
parents: 371
diff changeset
    26
	sii_write \
cc779f7d2496 Command-line help in the docs.
Florian Pose <fp@igh-essen.com>
parents: 371
diff changeset
    27
	states \
cc779f7d2496 Command-line help in the docs.
Florian Pose <fp@igh-essen.com>
parents: 371
diff changeset
    28
	xml
cc779f7d2496 Command-line help in the docs.
Florian Pose <fp@igh-essen.com>
parents: 371
diff changeset
    29
cc779f7d2496 Command-line help in the docs.
Florian Pose <fp@igh-essen.com>
parents: 371
diff changeset
    30
EXT_PREFIX := external/ethercat_
cc779f7d2496 Command-line help in the docs.
Florian Pose <fp@igh-essen.com>
parents: 371
diff changeset
    31
EXT_FILES := $(addprefix $(EXT_PREFIX),$(COMMANDS))
cc779f7d2496 Command-line help in the docs.
Florian Pose <fp@igh-essen.com>
parents: 371
diff changeset
    32
ETHERCAT_CMD := ../tool/ethercat
cc779f7d2496 Command-line help in the docs.
Florian Pose <fp@igh-essen.com>
parents: 371
diff changeset
    33
ETHERCAT_HELP := $(ETHERCAT_CMD) -h
cc779f7d2496 Command-line help in the docs.
Florian Pose <fp@igh-essen.com>
parents: 371
diff changeset
    34
369
7920ca086e5c Moved doc into trunk
Florian Pose <fp@igh-essen.com>
parents:
diff changeset
    35
#------------------------------------------------------------------------------
7920ca086e5c Moved doc into trunk
Florian Pose <fp@igh-essen.com>
parents:
diff changeset
    36
1140
cc779f7d2496 Command-line help in the docs.
Florian Pose <fp@igh-essen.com>
parents: 371
diff changeset
    37
all: pdf
369
7920ca086e5c Moved doc into trunk
Florian Pose <fp@igh-essen.com>
parents:
diff changeset
    38
1140
cc779f7d2496 Command-line help in the docs.
Florian Pose <fp@igh-essen.com>
parents: 371
diff changeset
    39
$(EXT_FILES): $(ETHERCAT_CMD)
cc779f7d2496 Command-line help in the docs.
Florian Pose <fp@igh-essen.com>
parents: 371
diff changeset
    40
	@mkdir -pv external
cc779f7d2496 Command-line help in the docs.
Florian Pose <fp@igh-essen.com>
parents: 371
diff changeset
    41
	@echo Creating $@...
cc779f7d2496 Command-line help in the docs.
Florian Pose <fp@igh-essen.com>
parents: 371
diff changeset
    42
	$(shell $(subst $(EXT_PREFIX),$(ETHERCAT_HELP) ,$@) > $@)
369
7920ca086e5c Moved doc into trunk
Florian Pose <fp@igh-essen.com>
parents:
diff changeset
    43
1140
cc779f7d2496 Command-line help in the docs.
Florian Pose <fp@igh-essen.com>
parents: 371
diff changeset
    44
pdf: $(EXT_FILES)
371
97f684433d3b Improved documentation makefile, removed svn.sty, fixed LaTeX penalties.
Florian Pose <fp@igh-essen.com>
parents: 370
diff changeset
    45
	pdflatex $(LATEX_OPTIONS) $(FILE)
97f684433d3b Improved documentation makefile, removed svn.sty, fixed LaTeX penalties.
Florian Pose <fp@igh-essen.com>
parents: 370
diff changeset
    46
97f684433d3b Improved documentation makefile, removed svn.sty, fixed LaTeX penalties.
Florian Pose <fp@igh-essen.com>
parents: 370
diff changeset
    47
index:
97f684433d3b Improved documentation makefile, removed svn.sty, fixed LaTeX penalties.
Florian Pose <fp@igh-essen.com>
parents: 370
diff changeset
    48
	makeindex $(FILE)
97f684433d3b Improved documentation makefile, removed svn.sty, fixed LaTeX penalties.
Florian Pose <fp@igh-essen.com>
parents: 370
diff changeset
    49
	makeindex $(FILE).glo -s nomencl.ist -o $(FILE).gls
369
7920ca086e5c Moved doc into trunk
Florian Pose <fp@igh-essen.com>
parents:
diff changeset
    50
7920ca086e5c Moved doc into trunk
Florian Pose <fp@igh-essen.com>
parents:
diff changeset
    51
clean:
7920ca086e5c Moved doc into trunk
Florian Pose <fp@igh-essen.com>
parents:
diff changeset
    52
	@rm -f $(FILE).aux $(FILE).dvi $(FILE).idx \
371
97f684433d3b Improved documentation makefile, removed svn.sty, fixed LaTeX penalties.
Florian Pose <fp@igh-essen.com>
parents: 370
diff changeset
    53
		$(FILE).ilg $(FILE).ind $(FILE).log \
97f684433d3b Improved documentation makefile, removed svn.sty, fixed LaTeX penalties.
Florian Pose <fp@igh-essen.com>
parents: 370
diff changeset
    54
		$(FILE).out $(FILE).pdf $(FILE).ps \
97f684433d3b Improved documentation makefile, removed svn.sty, fixed LaTeX penalties.
Florian Pose <fp@igh-essen.com>
parents: 370
diff changeset
    55
		$(FILE).toc $(FILE).lot $(FILE).lof \
97f684433d3b Improved documentation makefile, removed svn.sty, fixed LaTeX penalties.
Florian Pose <fp@igh-essen.com>
parents: 370
diff changeset
    56
		$(FILE).lol $(FILE).glo $(FILE).gls \
97f684433d3b Improved documentation makefile, removed svn.sty, fixed LaTeX penalties.
Florian Pose <fp@igh-essen.com>
parents: 370
diff changeset
    57
		images/*.bak *~
369
7920ca086e5c Moved doc into trunk
Florian Pose <fp@igh-essen.com>
parents:
diff changeset
    58
7920ca086e5c Moved doc into trunk
Florian Pose <fp@igh-essen.com>
parents:
diff changeset
    59
#------------------------------------------------------------------------------