[FFmpeg-devel] [PATCH] doc: make apidoc output independent of SRC_PATH

Andreas Cadhalpun andreas.cadhalpun at googlemail.com
Mon Dec 28 22:03:10 CET 2015


On 20.12.2015 23:31, Andreas Cadhalpun wrote:
> Previously it included the SRC_PATH in every title.
> 
> Signed-off-by: Andreas Cadhalpun <Andreas.Cadhalpun at googlemail.com>
> ---
>  doc/Makefile        |  7 ++++---
>  doc/doxy-wrapper.sh | 11 ++++++-----
>  2 files changed, 10 insertions(+), 8 deletions(-)
> 
> diff --git a/doc/Makefile b/doc/Makefile
> index 3e67c2a..afa7e22 100644
> --- a/doc/Makefile
> +++ b/doc/Makefile
> @@ -124,11 +124,12 @@ $(DOCS) doc/doxy/html: | doc/
>  $(DOC_EXAMPLES:%$(EXESUF)=%.o): | doc/examples
>  OBJDIRS += doc/examples
>  
> -DOXY_INPUT      = $(addprefix $(SRC_PATH)/, $(INSTHEADERS) $(DOC_EXAMPLES:%$(EXESUF)=%.c) $(LIB_EXAMPLES:%$(EXESUF)=%.c))
> +DOXY_INPUT      = $(INSTHEADERS) $(DOC_EXAMPLES:%$(EXESUF)=%.c) $(LIB_EXAMPLES:%$(EXESUF)=%.c)
> +DOXY_INPUT_DEPS = $(addprefix $(SRC_PATH)/, $(DOXY_INPUT))
>  
>  doc/doxy/html: TAG = DOXY
> -doc/doxy/html: $(SRC_PATH)/doc/Doxyfile $(SRC_PATH)/doc/doxy-wrapper.sh $(DOXY_INPUT)
> -	$(M)$(SRC_PATH)/doc/doxy-wrapper.sh $(SRC_PATH) $< $(DOXYGEN) $(DOXY_INPUT)
> +doc/doxy/html: $(SRC_PATH)/doc/Doxyfile $(SRC_PATH)/doc/doxy-wrapper.sh $(DOXY_INPUT_DEPS)
> +	OUT_DIR=$$PWD/doc/doxy; cd $(SRC_PATH); $(M)./doc/doxy-wrapper.sh $$OUT_DIR $< $(DOXYGEN) $(DOXY_INPUT);
>  
>  install-doc: install-html install-man
>  
> diff --git a/doc/doxy-wrapper.sh b/doc/doxy-wrapper.sh
> index 9720e54..0c02777 100755
> --- a/doc/doxy-wrapper.sh
> +++ b/doc/doxy-wrapper.sh
> @@ -1,21 +1,22 @@
>  #!/bin/sh
>  
> -SRC_PATH="${1}"
> +OUT_DIR="${1}"
>  DOXYFILE="${2}"
>  DOXYGEN="${3}"
>  
>  shift 3
>  
> -if [ -e "$SRC_PATH/VERSION" ]; then
> -    VERSION=`cat "$SRC_PATH/VERSION"`
> +if [ -e "VERSION" ]; then
> +    VERSION=`cat "VERSION"`
>  else
> -    VERSION=`cd "$SRC_PATH"; git describe`
> +    VERSION=`git describe`
>  fi
>  
>  $DOXYGEN - <<EOF
>  @INCLUDE        = ${DOXYFILE}
>  INPUT           = $@
> -EXAMPLE_PATH    = ${SRC_PATH}/doc/examples
> +EXAMPLE_PATH    = doc/examples
>  HTML_TIMESTAMP  = NO
>  PROJECT_NUMBER  = $VERSION
> +OUTPUT_DIRECTORY = $OUT_DIR
>  EOF
> 

Ping.

Best regards,
Andreas


More information about the ffmpeg-devel mailing list