* [FFmpeg-devel] [PATCH] Makefile: Build complete doc with Doxygen
@ 2022-09-24 21:09 Marvin Scholz
2022-10-11 13:27 ` Marvin Scholz
` (2 more replies)
0 siblings, 3 replies; 5+ messages in thread
From: Marvin Scholz @ 2022-09-24 21:09 UTC (permalink / raw)
To: ffmpeg-devel; +Cc: Marvin Scholz
Add DISABLEDINSTHEADERS, a variable containing the headers of disabled
libraries. This is needed so that Doxygen does not generate incomplete
documentation when a component is disabled, which is quite unexpected
behaviour and results in warnings due to, among other things, broken
references.
---
Makefile | 10 ++++++++++
doc/Makefile | 2 +-
2 files changed, 11 insertions(+), 1 deletion(-)
diff --git a/Makefile b/Makefile
index 61f79e27ae..26714950b7 100644
--- a/Makefile
+++ b/Makefile
@@ -110,7 +110,17 @@ include $(SRC_PATH)/$(1)/Makefile
include $(SRC_PATH)/ffbuild/library.mak
endef
+define DODISABLEDSUBDIR
+$(foreach V,$(SUBDIR_VARS),$(eval $(call RESET,$(V))))
+SUBDIR := $(1)/
+include $(SRC_PATH)/$(1)/Makefile
+DISABLEDINSTHEADERS := $$(DISABLEDINSTHEADERS) $$(HEADERS:%=$$(SUBDIR)%)
+endef
+
+DISABLEDFFLIBS := $(filter-out $(FFLIBS),$(ALLFFLIBS))
+
$(foreach D,$(FFLIBS),$(eval $(call DOSUBDIR,lib$(D))))
+$(foreach D,$(DISABLEDFFLIBS),$(eval $(call DODISABLEDSUBDIR,lib$(D))))
include $(SRC_PATH)/fftools/Makefile
include $(SRC_PATH)/doc/Makefile
diff --git a/doc/Makefile b/doc/Makefile
index 25774c7bad..d71a02e408 100644
--- a/doc/Makefile
+++ b/doc/Makefile
@@ -100,7 +100,7 @@ doc/%.3: doc/%.pod $(GENTEXI)
$(DOCS) doc/doxy/html: | doc/
-DOXY_INPUT = $(INSTHEADERS)
+DOXY_INPUT = $(INSTHEADERS) $(DISABLEDINSTHEADERS)
DOXY_INPUT_DEPS = $(addprefix $(SRC_PATH)/, $(DOXY_INPUT)) ffbuild/config.mak
doc/doxy/html: TAG = DOXY
--
2.37.0 (Apple Git-136)
_______________________________________________
ffmpeg-devel mailing list
ffmpeg-devel@ffmpeg.org
https://ffmpeg.org/mailman/listinfo/ffmpeg-devel
To unsubscribe, visit link above, or email
ffmpeg-devel-request@ffmpeg.org with subject "unsubscribe".
^ permalink raw reply [flat|nested] 5+ messages in thread
* Re: [FFmpeg-devel] [PATCH] Makefile: Build complete doc with Doxygen
2022-09-24 21:09 [FFmpeg-devel] [PATCH] Makefile: Build complete doc with Doxygen Marvin Scholz
@ 2022-10-11 13:27 ` Marvin Scholz
2022-11-08 13:43 ` Marvin Scholz
2022-11-16 17:21 ` Marvin Scholz
2 siblings, 0 replies; 5+ messages in thread
From: Marvin Scholz @ 2022-10-11 13:27 UTC (permalink / raw)
To: ffmpeg-devel; +Cc: Marvin Scholz
On 24 Sep 2022, at 23:09, Marvin Scholz wrote:
> Add DISABLEDINSTHEADERS, a variable containing the headers of disabled
> libraries. This is needed so that Doxygen does not generate incomplete
> documentation when a component is disabled, which is quite unexpected
> behaviour and results in warnings due to, among other things, broken
> references.
> ---
> Makefile | 10 ++++++++++
> doc/Makefile | 2 +-
> 2 files changed, 11 insertions(+), 1 deletion(-)
>
> diff --git a/Makefile b/Makefile
> index 61f79e27ae..26714950b7 100644
> --- a/Makefile
> +++ b/Makefile
> @@ -110,7 +110,17 @@ include $(SRC_PATH)/$(1)/Makefile
> include $(SRC_PATH)/ffbuild/library.mak
> endef
>
> +define DODISABLEDSUBDIR
> +$(foreach V,$(SUBDIR_VARS),$(eval $(call RESET,$(V))))
> +SUBDIR := $(1)/
> +include $(SRC_PATH)/$(1)/Makefile
> +DISABLEDINSTHEADERS := $$(DISABLEDINSTHEADERS) $$(HEADERS:%=$$(SUBDIR)%)
> +endef
> +
> +DISABLEDFFLIBS := $(filter-out $(FFLIBS),$(ALLFFLIBS))
> +
> $(foreach D,$(FFLIBS),$(eval $(call DOSUBDIR,lib$(D))))
> +$(foreach D,$(DISABLEDFFLIBS),$(eval $(call DODISABLEDSUBDIR,lib$(D))))
>
> include $(SRC_PATH)/fftools/Makefile
> include $(SRC_PATH)/doc/Makefile
> diff --git a/doc/Makefile b/doc/Makefile
> index 25774c7bad..d71a02e408 100644
> --- a/doc/Makefile
> +++ b/doc/Makefile
> @@ -100,7 +100,7 @@ doc/%.3: doc/%.pod $(GENTEXI)
>
> $(DOCS) doc/doxy/html: | doc/
>
> -DOXY_INPUT = $(INSTHEADERS)
> +DOXY_INPUT = $(INSTHEADERS) $(DISABLEDINSTHEADERS)
> DOXY_INPUT_DEPS = $(addprefix $(SRC_PATH)/, $(DOXY_INPUT)) ffbuild/config.mak
>
> doc/doxy/html: TAG = DOXY
> --
> 2.37.0 (Apple Git-136)
Ping for review, please.
_______________________________________________
ffmpeg-devel mailing list
ffmpeg-devel@ffmpeg.org
https://ffmpeg.org/mailman/listinfo/ffmpeg-devel
To unsubscribe, visit link above, or email
ffmpeg-devel-request@ffmpeg.org with subject "unsubscribe".
^ permalink raw reply [flat|nested] 5+ messages in thread
* Re: [FFmpeg-devel] [PATCH] Makefile: Build complete doc with Doxygen
2022-09-24 21:09 [FFmpeg-devel] [PATCH] Makefile: Build complete doc with Doxygen Marvin Scholz
2022-10-11 13:27 ` Marvin Scholz
@ 2022-11-08 13:43 ` Marvin Scholz
2022-11-16 17:21 ` Marvin Scholz
2 siblings, 0 replies; 5+ messages in thread
From: Marvin Scholz @ 2022-11-08 13:43 UTC (permalink / raw)
To: ffmpeg-devel
On 24 Sep 2022, at 23:09, Marvin Scholz wrote:
> Add DISABLEDINSTHEADERS, a variable containing the headers of disabled
> libraries. This is needed so that Doxygen does not generate incomplete
> documentation when a component is disabled, which is quite unexpected
> behaviour and results in warnings due to, among other things, broken
> references.
> ---
> Makefile | 10 ++++++++++
> doc/Makefile | 2 +-
> 2 files changed, 11 insertions(+), 1 deletion(-)
>
> diff --git a/Makefile b/Makefile
> index 61f79e27ae..26714950b7 100644
> --- a/Makefile
> +++ b/Makefile
> @@ -110,7 +110,17 @@ include $(SRC_PATH)/$(1)/Makefile
> include $(SRC_PATH)/ffbuild/library.mak
> endef
>
> +define DODISABLEDSUBDIR
> +$(foreach V,$(SUBDIR_VARS),$(eval $(call RESET,$(V))))
> +SUBDIR := $(1)/
> +include $(SRC_PATH)/$(1)/Makefile
> +DISABLEDINSTHEADERS := $$(DISABLEDINSTHEADERS) $$(HEADERS:%=$$(SUBDIR)%)
> +endef
> +
> +DISABLEDFFLIBS := $(filter-out $(FFLIBS),$(ALLFFLIBS))
> +
> $(foreach D,$(FFLIBS),$(eval $(call DOSUBDIR,lib$(D))))
> +$(foreach D,$(DISABLEDFFLIBS),$(eval $(call DODISABLEDSUBDIR,lib$(D))))
>
> include $(SRC_PATH)/fftools/Makefile
> include $(SRC_PATH)/doc/Makefile
> diff --git a/doc/Makefile b/doc/Makefile
> index 25774c7bad..d71a02e408 100644
> --- a/doc/Makefile
> +++ b/doc/Makefile
> @@ -100,7 +100,7 @@ doc/%.3: doc/%.pod $(GENTEXI)
>
> $(DOCS) doc/doxy/html: | doc/
>
> -DOXY_INPUT = $(INSTHEADERS)
> +DOXY_INPUT = $(INSTHEADERS) $(DISABLEDINSTHEADERS)
> DOXY_INPUT_DEPS = $(addprefix $(SRC_PATH)/, $(DOXY_INPUT)) ffbuild/config.mak
>
> doc/doxy/html: TAG = DOXY
> --
> 2.37.0 (Apple Git-136)
Another ping for review, please.
_______________________________________________
ffmpeg-devel mailing list
ffmpeg-devel@ffmpeg.org
https://ffmpeg.org/mailman/listinfo/ffmpeg-devel
To unsubscribe, visit link above, or email
ffmpeg-devel-request@ffmpeg.org with subject "unsubscribe".
^ permalink raw reply [flat|nested] 5+ messages in thread
* Re: [FFmpeg-devel] [PATCH] Makefile: Build complete doc with Doxygen
2022-09-24 21:09 [FFmpeg-devel] [PATCH] Makefile: Build complete doc with Doxygen Marvin Scholz
2022-10-11 13:27 ` Marvin Scholz
2022-11-08 13:43 ` Marvin Scholz
@ 2022-11-16 17:21 ` Marvin Scholz
2022-11-24 22:00 ` Jan Ekström
2 siblings, 1 reply; 5+ messages in thread
From: Marvin Scholz @ 2022-11-16 17:21 UTC (permalink / raw)
To: ffmpeg-devel; +Cc: Marvin Scholz
On 24 Sep 2022, at 23:09, Marvin Scholz wrote:
> Add DISABLEDINSTHEADERS, a variable containing the headers of disabled
> libraries. This is needed so that Doxygen does not generate incomplete
> documentation when a component is disabled, which is quite unexpected
> behaviour and results in warnings due to, among other things, broken
> references.
> ---
> Makefile | 10 ++++++++++
> doc/Makefile | 2 +-
> 2 files changed, 11 insertions(+), 1 deletion(-)
>
> diff --git a/Makefile b/Makefile
> index 61f79e27ae..26714950b7 100644
> --- a/Makefile
> +++ b/Makefile
> @@ -110,7 +110,17 @@ include $(SRC_PATH)/$(1)/Makefile
> include $(SRC_PATH)/ffbuild/library.mak
> endef
>
> +define DODISABLEDSUBDIR
> +$(foreach V,$(SUBDIR_VARS),$(eval $(call RESET,$(V))))
> +SUBDIR := $(1)/
> +include $(SRC_PATH)/$(1)/Makefile
> +DISABLEDINSTHEADERS := $$(DISABLEDINSTHEADERS) $$(HEADERS:%=$$(SUBDIR)%)
> +endef
> +
> +DISABLEDFFLIBS := $(filter-out $(FFLIBS),$(ALLFFLIBS))
> +
> $(foreach D,$(FFLIBS),$(eval $(call DOSUBDIR,lib$(D))))
> +$(foreach D,$(DISABLEDFFLIBS),$(eval $(call DODISABLEDSUBDIR,lib$(D))))
>
> include $(SRC_PATH)/fftools/Makefile
> include $(SRC_PATH)/doc/Makefile
> diff --git a/doc/Makefile b/doc/Makefile
> index 25774c7bad..d71a02e408 100644
> --- a/doc/Makefile
> +++ b/doc/Makefile
> @@ -100,7 +100,7 @@ doc/%.3: doc/%.pod $(GENTEXI)
>
> $(DOCS) doc/doxy/html: | doc/
>
> -DOXY_INPUT = $(INSTHEADERS)
> +DOXY_INPUT = $(INSTHEADERS) $(DISABLEDINSTHEADERS)
> DOXY_INPUT_DEPS = $(addprefix $(SRC_PATH)/, $(DOXY_INPUT)) ffbuild/config.mak
>
> doc/doxy/html: TAG = DOXY
> --
> 2.37.0 (Apple Git-136)
Ping for review
_______________________________________________
ffmpeg-devel mailing list
ffmpeg-devel@ffmpeg.org
https://ffmpeg.org/mailman/listinfo/ffmpeg-devel
To unsubscribe, visit link above, or email
ffmpeg-devel-request@ffmpeg.org with subject "unsubscribe".
^ permalink raw reply [flat|nested] 5+ messages in thread
* Re: [FFmpeg-devel] [PATCH] Makefile: Build complete doc with Doxygen
2022-11-16 17:21 ` Marvin Scholz
@ 2022-11-24 22:00 ` Jan Ekström
0 siblings, 0 replies; 5+ messages in thread
From: Jan Ekström @ 2022-11-24 22:00 UTC (permalink / raw)
To: FFmpeg development discussions and patches
On Wed, Nov 16, 2022 at 7:21 PM Marvin Scholz <epirat07@gmail.com> wrote:
>
> On 24 Sep 2022, at 23:09, Marvin Scholz wrote:
>
> > Add DISABLEDINSTHEADERS, a variable containing the headers of disabled
> > libraries. This is needed so that Doxygen does not generate incomplete
> > documentation when a component is disabled, which is quite unexpected
> > behaviour and results in warnings due to, among other things, broken
> > references.
> > ---
I can get behind the idea of "always building the full docs,
especially if the documentation is otherwise broken.", thus +1 for the
idea behind the patch at least.
> > Makefile | 10 ++++++++++
> > doc/Makefile | 2 +-
> > 2 files changed, 11 insertions(+), 1 deletion(-)
> >
> > diff --git a/Makefile b/Makefile
> > index 61f79e27ae..26714950b7 100644
> > --- a/Makefile
> > +++ b/Makefile
> > @@ -110,7 +110,17 @@ include $(SRC_PATH)/$(1)/Makefile
> > include $(SRC_PATH)/ffbuild/library.mak
> > endef
> >
> > +define DODISABLEDSUBDIR
> > +$(foreach V,$(SUBDIR_VARS),$(eval $(call RESET,$(V))))
> > +SUBDIR := $(1)/
> > +include $(SRC_PATH)/$(1)/Makefile
Now, I am not 100% sure what the effect of this inclusion is, so it'd
be nice if you could enlighten me. I see there are some unconditional
definitions in f.ex. libavcodec/Makefile (such as TESTPROGS), but
would those be still under the defined NAME (avcodec) or so, and thus
effectively not affect the build even where some unconditional
definitions exist in the included Makefile?
Do excuse me if there is a very similar inclusion for something not
enabled just outside of the patch diff context, thus noting that this
is completely OK :)
> > +DISABLEDINSTHEADERS := $$(DISABLEDINSTHEADERS) $$(HEADERS:%=$$(SUBDIR)%)
> > +endef
> > +
> > +DISABLEDFFLIBS := $(filter-out $(FFLIBS),$(ALLFFLIBS))
> > +
> > $(foreach D,$(FFLIBS),$(eval $(call DOSUBDIR,lib$(D))))
> > +$(foreach D,$(DISABLEDFFLIBS),$(eval $(call DODISABLEDSUBDIR,lib$(D))))
> >
> > include $(SRC_PATH)/fftools/Makefile
> > include $(SRC_PATH)/doc/Makefile
> > diff --git a/doc/Makefile b/doc/Makefile
> > index 25774c7bad..d71a02e408 100644
> > --- a/doc/Makefile
> > +++ b/doc/Makefile
> > @@ -100,7 +100,7 @@ doc/%.3: doc/%.pod $(GENTEXI)
> >
> > $(DOCS) doc/doxy/html: | doc/
> >
> > -DOXY_INPUT = $(INSTHEADERS)
> > +DOXY_INPUT = $(INSTHEADERS) $(DISABLEDINSTHEADERS)
> > DOXY_INPUT_DEPS = $(addprefix $(SRC_PATH)/, $(DOXY_INPUT)) ffbuild/config.mak
> >
> > doc/doxy/html: TAG = DOXY
> > --
> > 2.37.0 (Apple Git-136)
>
> Ping for review
Jan
_______________________________________________
ffmpeg-devel mailing list
ffmpeg-devel@ffmpeg.org
https://ffmpeg.org/mailman/listinfo/ffmpeg-devel
To unsubscribe, visit link above, or email
ffmpeg-devel-request@ffmpeg.org with subject "unsubscribe".
^ permalink raw reply [flat|nested] 5+ messages in thread
end of thread, other threads:[~2022-11-24 22:01 UTC | newest]
Thread overview: 5+ messages (download: mbox.gz / follow: Atom feed)
-- links below jump to the message on this page --
2022-09-24 21:09 [FFmpeg-devel] [PATCH] Makefile: Build complete doc with Doxygen Marvin Scholz
2022-10-11 13:27 ` Marvin Scholz
2022-11-08 13:43 ` Marvin Scholz
2022-11-16 17:21 ` Marvin Scholz
2022-11-24 22:00 ` Jan Ekström
Git Inbox Mirror of the ffmpeg-devel mailing list - see https://ffmpeg.org/mailman/listinfo/ffmpeg-devel
This inbox may be cloned and mirrored by anyone:
git clone --mirror https://master.gitmailbox.com/ffmpegdev/0 ffmpegdev/git/0.git
# If you have public-inbox 1.1+ installed, you may
# initialize and index your mirror using the following commands:
public-inbox-init -V2 ffmpegdev ffmpegdev/ https://master.gitmailbox.com/ffmpegdev \
ffmpegdev@gitmailbox.com
public-inbox-index ffmpegdev
Example config snippet for mirrors.
AGPL code for this site: git clone https://public-inbox.org/public-inbox.git