10df176b0f
This is an attempt to bring the README files in line with the current status of the OpenOCD development. - remove some obsolete information and duplicated instructions - reword some statements - restructure in a way more appealing to a regular user - add a supported hardware list to allow a potential user to determine if his/her usecase is covered by a freetext keyword search through the document - Add OSX notes (courtesy GrizzlyAdams and inca) Since most ftdi-based adapters are now covered by the ftdi driver, I think it's ok to remove some of the libftdi/ftd2xx instructions, the few users who still need them should refer to upstream docs instead. I'm not sure if README.Windows should come with the DOS line endings, but i'd expect many windows users to use their silly notepad to view it, and notepad ignores LF apparently. (Decided to use LF anyway.) I understand discussing and reviewing such a massive README change is a somewhat demanding task but I feel it's a necessity to move forward maintaining proper documentation. Change-Id: Idfde3014c72dd5c32ad292ee1ab205322e51a138 Signed-off-by: Paul Fertser <fercerpav@gmail.com> Signed-off-by: Andreas Fritiofson <andreas.fritiofson@gmail.com> Reviewed-on: http://openocd.zylin.com/1503 Tested-by: jenkins Reviewed-by: Xiaofan <xiaofanc@gmail.com>
110 lines
2.7 KiB
Makefile
110 lines
2.7 KiB
Makefile
# not a GNU package. You can remove this line, if
|
|
# have all needed files, that a GNU package needs
|
|
AUTOMAKE_OPTIONS = gnu 1.6
|
|
|
|
# make sure we pass the correct jimtcl flags to distcheck
|
|
DISTCHECK_CONFIGURE_FLAGS = --disable-install-jim
|
|
|
|
nobase_dist_pkgdata_DATA = \
|
|
contrib/libdcc/dcc_stdio.c \
|
|
contrib/libdcc/dcc_stdio.h \
|
|
contrib/libdcc/example.c \
|
|
contrib/libdcc/README \
|
|
contrib/openocd.udev
|
|
|
|
if INTERNAL_JIMTCL
|
|
SUBDIRS = jimtcl
|
|
else
|
|
SUBDIRS =
|
|
endif
|
|
|
|
SUBDIRS += src doc
|
|
|
|
EXTRA_DIST = \
|
|
BUGS \
|
|
HACKING \
|
|
NEWTAPS \
|
|
README.Windows \
|
|
README.OSX \
|
|
Doxyfile.in \
|
|
tools/logger.pl \
|
|
contrib/loaders
|
|
|
|
libtool: $(LIBTOOL_DEPS)
|
|
$(SHELL) ./config.status --recheck
|
|
|
|
docs: pdf html doxygen
|
|
|
|
Doxyfile: $(srcdir)/Doxyfile.in
|
|
@echo "Creating $@ from $<..."
|
|
@( \
|
|
echo "### @@@ -= DO NOT EDIT THIS FILE =- @@@ ###" && \
|
|
echo "### @@@ Make changes to Doxyfile.in @@@ ###" && \
|
|
sed -e 's,@srcdir\@,$(srcdir),' \
|
|
-e 's,@builddir\@,$(builddir),' \
|
|
-e 's,@doxygen_as_html\@,$(doxygen_as_html),' \
|
|
-e 's,@doxygen_as_pdf\@,$(doxygen_as_pdf),' $< \
|
|
) > $@
|
|
|
|
THE_MANUAL = doxygen/latex/refman.pdf
|
|
|
|
doxygen::
|
|
$(MAKE) Doxyfile
|
|
doxygen Doxyfile 2>&1 | perl $(srcdir)/tools/logger.pl > doxygen.log
|
|
@if [ -f doxygen/latex/refman.tex ]; then \
|
|
echo "Creating $(THE_MANUAL)..."; \
|
|
$(MAKE) $(THE_MANUAL); \
|
|
else \
|
|
echo "Skipping Doxygen PDF..."; \
|
|
fi
|
|
|
|
$(THE_MANUAL): %.pdf: %.tex
|
|
-cd $$(dirname $*) && pdflatex $$(basename $*)
|
|
-cd $$(dirname $*) && pdflatex $$(basename $*)
|
|
|
|
TCL_PATH = tcl
|
|
# command to find paths of script files, relative to TCL_PATH
|
|
TCL_FILES = find $(srcdir)/$(TCL_PATH) -name '*.cfg' -o -name '*.tcl' -o -name '*.txt' | \
|
|
sed -e 's,^$(srcdir)/$(TCL_PATH),,'
|
|
|
|
dist-hook:
|
|
if test -d $(srcdir)/.git -a \( ! -e $(distdir)/ChangeLog -o -w $(distdir)/ChangeLog \) ; then \
|
|
git --git-dir $(srcdir)/.git log | $(srcdir)/tools/git2cl/git2cl > $(distdir)/ChangeLog ; \
|
|
fi
|
|
for i in $$($(TCL_FILES)); do \
|
|
j="$(distdir)/$(TCL_PATH)/$$i" && \
|
|
mkdir -p "$$(dirname $$j)" && \
|
|
$(INSTALL_DATA) $(srcdir)/$(TCL_PATH)/$$i $$j; \
|
|
done
|
|
|
|
install-data-hook:
|
|
for i in $$($(TCL_FILES)); do \
|
|
j="$(DESTDIR)$(pkgdatadir)/scripts/$$i" && \
|
|
mkdir -p "$$(dirname $$j)" && \
|
|
$(INSTALL_DATA) $(srcdir)/$(TCL_PATH)/$$i $$j; \
|
|
done
|
|
|
|
uninstall-hook:
|
|
rm -rf $(DESTDIR)$(pkgdatadir)/scripts
|
|
|
|
distclean-local:
|
|
rm -rf Doxyfile doxygen
|
|
rm -f $(srcdir)/jimtcl/configure.gnu
|
|
|
|
DISTCLEANFILES = doxygen.log
|
|
|
|
MAINTAINERCLEANFILES = \
|
|
$(srcdir)/INSTALL \
|
|
$(srcdir)/configure \
|
|
$(srcdir)/Makefile.in \
|
|
$(srcdir)/depcomp \
|
|
$(srcdir)/config.guess \
|
|
$(srcdir)/config.sub \
|
|
$(srcdir)/config.h.in \
|
|
$(srcdir)/config.h.in~ \
|
|
$(srcdir)/compile \
|
|
$(srcdir)/ltmain.sh \
|
|
$(srcdir)/missing \
|
|
$(srcdir)/aclocal.m4 \
|
|
$(srcdir)/install-sh
|