documentation/Makefile
author Martin Troxler <ch1010277@ch10pc446>
Tue, 09 Nov 2010 11:12:35 +0100
changeset 1997 65bcd7e304cf
parent 1917 6129a5f715fb
child 2646 0c56c67072a6
permissions -rw-r--r--
hg ignored debuild.log
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 \
1514
85ac1c91045d Added 'ethercat cstruct' command to output PDO information in C language.
Florian Pose <fp@igh-essen.com>
parents: 1485
diff changeset
    16
	cstruct \
1140
cc779f7d2496 Command-line help in the docs.
Florian Pose <fp@igh-essen.com>
parents: 371
diff changeset
    17
	data \
cc779f7d2496 Command-line help in the docs.
Florian Pose <fp@igh-essen.com>
parents: 371
diff changeset
    18
	debug \
cc779f7d2496 Command-line help in the docs.
Florian Pose <fp@igh-essen.com>
parents: 371
diff changeset
    19
	domains \
1423
41e3baa2da23 Updated command doc.
Florian Pose <fp@igh-essen.com>
parents: 1306
diff changeset
    20
	download \
1485
5ddc3a455059 ethercat eoe command.
Florian Pose <fp@igh-essen.com>
parents: 1423
diff changeset
    21
	eoe \
1423
41e3baa2da23 Updated command doc.
Florian Pose <fp@igh-essen.com>
parents: 1306
diff changeset
    22
	foe_read \
41e3baa2da23 Updated command doc.
Florian Pose <fp@igh-essen.com>
parents: 1306
diff changeset
    23
	foe_write \
41e3baa2da23 Updated command doc.
Florian Pose <fp@igh-essen.com>
parents: 1306
diff changeset
    24
	graph \
1140
cc779f7d2496 Command-line help in the docs.
Florian Pose <fp@igh-essen.com>
parents: 371
diff changeset
    25
	master \
cc779f7d2496 Command-line help in the docs.
Florian Pose <fp@igh-essen.com>
parents: 371
diff changeset
    26
	pdos \
1423
41e3baa2da23 Updated command doc.
Florian Pose <fp@igh-essen.com>
parents: 1306
diff changeset
    27
	reg_read \
41e3baa2da23 Updated command doc.
Florian Pose <fp@igh-essen.com>
parents: 1306
diff changeset
    28
	reg_write \
1140
cc779f7d2496 Command-line help in the docs.
Florian Pose <fp@igh-essen.com>
parents: 371
diff changeset
    29
	sdos \
cc779f7d2496 Command-line help in the docs.
Florian Pose <fp@igh-essen.com>
parents: 371
diff changeset
    30
	sii_read \
cc779f7d2496 Command-line help in the docs.
Florian Pose <fp@igh-essen.com>
parents: 371
diff changeset
    31
	sii_write \
1423
41e3baa2da23 Updated command doc.
Florian Pose <fp@igh-essen.com>
parents: 1306
diff changeset
    32
	slaves \
1917
6129a5f715fb SoE documentation.
Florian Pose <fp@igh-essen.com>
parents: 1514
diff changeset
    33
	soe_read \
6129a5f715fb SoE documentation.
Florian Pose <fp@igh-essen.com>
parents: 1514
diff changeset
    34
	soe_write \
1140
cc779f7d2496 Command-line help in the docs.
Florian Pose <fp@igh-essen.com>
parents: 371
diff changeset
    35
	states \
1423
41e3baa2da23 Updated command doc.
Florian Pose <fp@igh-essen.com>
parents: 1306
diff changeset
    36
	upload \
41e3baa2da23 Updated command doc.
Florian Pose <fp@igh-essen.com>
parents: 1306
diff changeset
    37
	version \
1140
cc779f7d2496 Command-line help in the docs.
Florian Pose <fp@igh-essen.com>
parents: 371
diff changeset
    38
	xml
cc779f7d2496 Command-line help in the docs.
Florian Pose <fp@igh-essen.com>
parents: 371
diff changeset
    39
cc779f7d2496 Command-line help in the docs.
Florian Pose <fp@igh-essen.com>
parents: 371
diff changeset
    40
EXT_PREFIX := external/ethercat_
cc779f7d2496 Command-line help in the docs.
Florian Pose <fp@igh-essen.com>
parents: 371
diff changeset
    41
EXT_FILES := $(addprefix $(EXT_PREFIX),$(COMMANDS))
cc779f7d2496 Command-line help in the docs.
Florian Pose <fp@igh-essen.com>
parents: 371
diff changeset
    42
ETHERCAT_CMD := ../tool/ethercat
cc779f7d2496 Command-line help in the docs.
Florian Pose <fp@igh-essen.com>
parents: 371
diff changeset
    43
ETHERCAT_HELP := $(ETHERCAT_CMD) -h
cc779f7d2496 Command-line help in the docs.
Florian Pose <fp@igh-essen.com>
parents: 371
diff changeset
    44
369
7920ca086e5c Moved doc into trunk
Florian Pose <fp@igh-essen.com>
parents:
diff changeset
    45
#------------------------------------------------------------------------------
7920ca086e5c Moved doc into trunk
Florian Pose <fp@igh-essen.com>
parents:
diff changeset
    46
1140
cc779f7d2496 Command-line help in the docs.
Florian Pose <fp@igh-essen.com>
parents: 371
diff changeset
    47
all: pdf
369
7920ca086e5c Moved doc into trunk
Florian Pose <fp@igh-essen.com>
parents:
diff changeset
    48
1140
cc779f7d2496 Command-line help in the docs.
Florian Pose <fp@igh-essen.com>
parents: 371
diff changeset
    49
$(EXT_FILES): $(ETHERCAT_CMD)
cc779f7d2496 Command-line help in the docs.
Florian Pose <fp@igh-essen.com>
parents: 371
diff changeset
    50
	@mkdir -pv external
cc779f7d2496 Command-line help in the docs.
Florian Pose <fp@igh-essen.com>
parents: 371
diff changeset
    51
	@echo Creating $@...
cc779f7d2496 Command-line help in the docs.
Florian Pose <fp@igh-essen.com>
parents: 371
diff changeset
    52
	$(shell $(subst $(EXT_PREFIX),$(ETHERCAT_HELP) ,$@) > $@)
369
7920ca086e5c Moved doc into trunk
Florian Pose <fp@igh-essen.com>
parents:
diff changeset
    53
1140
cc779f7d2496 Command-line help in the docs.
Florian Pose <fp@igh-essen.com>
parents: 371
diff changeset
    54
pdf: $(EXT_FILES)
1202
91d190223daa Next changes for the documentation.
Florian Pose <fp@igh-essen.com>
parents: 1140
diff changeset
    55
	$(MAKE) -C images
91d190223daa Next changes for the documentation.
Florian Pose <fp@igh-essen.com>
parents: 1140
diff changeset
    56
	$(MAKE) -C graphs
371
97f684433d3b Improved documentation makefile, removed svn.sty, fixed LaTeX penalties.
Florian Pose <fp@igh-essen.com>
parents: 370
diff changeset
    57
	pdflatex $(LATEX_OPTIONS) $(FILE)
97f684433d3b Improved documentation makefile, removed svn.sty, fixed LaTeX penalties.
Florian Pose <fp@igh-essen.com>
parents: 370
diff changeset
    58
97f684433d3b Improved documentation makefile, removed svn.sty, fixed LaTeX penalties.
Florian Pose <fp@igh-essen.com>
parents: 370
diff changeset
    59
index:
97f684433d3b Improved documentation makefile, removed svn.sty, fixed LaTeX penalties.
Florian Pose <fp@igh-essen.com>
parents: 370
diff changeset
    60
	makeindex $(FILE)
1306
a27c839d043b merge -r1566:1573 branches/stable-1.4: Documentation.
Florian Pose <fp@igh-essen.com>
parents: 1289
diff changeset
    61
	makeindex $(FILE).nlo -s nomencl.ist -o $(FILE).nls
369
7920ca086e5c Moved doc into trunk
Florian Pose <fp@igh-essen.com>
parents:
diff changeset
    62
7920ca086e5c Moved doc into trunk
Florian Pose <fp@igh-essen.com>
parents:
diff changeset
    63
clean:
1289
5b82b6b39c2d Removed unnecessary modules; renamed references.
Florian Pose <fp@igh-essen.com>
parents: 1202
diff changeset
    64
	@rm -f \
5b82b6b39c2d Removed unnecessary modules; renamed references.
Florian Pose <fp@igh-essen.com>
parents: 1202
diff changeset
    65
		$(FILE).aux \
5b82b6b39c2d Removed unnecessary modules; renamed references.
Florian Pose <fp@igh-essen.com>
parents: 1202
diff changeset
    66
		$(FILE).dvi \
5b82b6b39c2d Removed unnecessary modules; renamed references.
Florian Pose <fp@igh-essen.com>
parents: 1202
diff changeset
    67
		$(FILE).idx \
5b82b6b39c2d Removed unnecessary modules; renamed references.
Florian Pose <fp@igh-essen.com>
parents: 1202
diff changeset
    68
		$(FILE).ilg \
5b82b6b39c2d Removed unnecessary modules; renamed references.
Florian Pose <fp@igh-essen.com>
parents: 1202
diff changeset
    69
		$(FILE).ind \
5b82b6b39c2d Removed unnecessary modules; renamed references.
Florian Pose <fp@igh-essen.com>
parents: 1202
diff changeset
    70
		$(FILE).lof \
5b82b6b39c2d Removed unnecessary modules; renamed references.
Florian Pose <fp@igh-essen.com>
parents: 1202
diff changeset
    71
		$(FILE).log \
5b82b6b39c2d Removed unnecessary modules; renamed references.
Florian Pose <fp@igh-essen.com>
parents: 1202
diff changeset
    72
		$(FILE).lol \
5b82b6b39c2d Removed unnecessary modules; renamed references.
Florian Pose <fp@igh-essen.com>
parents: 1202
diff changeset
    73
		$(FILE).lot \
5b82b6b39c2d Removed unnecessary modules; renamed references.
Florian Pose <fp@igh-essen.com>
parents: 1202
diff changeset
    74
		$(FILE).nlo \
1306
a27c839d043b merge -r1566:1573 branches/stable-1.4: Documentation.
Florian Pose <fp@igh-essen.com>
parents: 1289
diff changeset
    75
		$(FILE).nls \
1289
5b82b6b39c2d Removed unnecessary modules; renamed references.
Florian Pose <fp@igh-essen.com>
parents: 1202
diff changeset
    76
		$(FILE).out \
5b82b6b39c2d Removed unnecessary modules; renamed references.
Florian Pose <fp@igh-essen.com>
parents: 1202
diff changeset
    77
		$(FILE).pdf \
5b82b6b39c2d Removed unnecessary modules; renamed references.
Florian Pose <fp@igh-essen.com>
parents: 1202
diff changeset
    78
		$(FILE).toc \
5b82b6b39c2d Removed unnecessary modules; renamed references.
Florian Pose <fp@igh-essen.com>
parents: 1202
diff changeset
    79
		*~ \
5b82b6b39c2d Removed unnecessary modules; renamed references.
Florian Pose <fp@igh-essen.com>
parents: 1202
diff changeset
    80
		images/*.bak
369
7920ca086e5c Moved doc into trunk
Florian Pose <fp@igh-essen.com>
parents:
diff changeset
    81
7920ca086e5c Moved doc into trunk
Florian Pose <fp@igh-essen.com>
parents:
diff changeset
    82
#------------------------------------------------------------------------------