This is an automated email from the git hooks/post-receive script. guillem pushed a commit to branch main in repository dpkg.
View the commit online: https://git.dpkg.org/cgit/dpkg/dpkg.git/commit/?id=6cc764c357957ee3085492658a0013fa9e2cbf69 commit 6cc764c357957ee3085492658a0013fa9e2cbf69 (HEAD -> main) Author: Guillem Jover <[email protected]> AuthorDate: Sun Aug 18 02:51:50 2024 +0200 scripts/mk: Document public API and expected directory to include from We should be explicit about what we consider the public API for these files, and what is the expected directory to include the fragments from. Prompted-by: Helmut Grohne <[email protected]> --- scripts/mk/architecture.mk | 4 ++++ scripts/mk/buildapi.mk | 4 ++++ scripts/mk/buildflags.mk | 3 +++ scripts/mk/buildopts.mk | 4 ++++ scripts/mk/buildtools.mk | 4 ++++ scripts/mk/default.mk | 4 ++++ scripts/mk/pkg-info.mk | 4 ++++ scripts/mk/vendor.mk | 4 ++++ 8 files changed, 31 insertions(+) diff --git a/scripts/mk/architecture.mk b/scripts/mk/architecture.mk index c2f6a054d..e506fb672 100644 --- a/scripts/mk/architecture.mk +++ b/scripts/mk/architecture.mk @@ -2,6 +2,10 @@ # DEB_BUILD_* variables that dpkg-architecture can return. Existing values # of those variables are preserved as per policy. # All variables are exported. +# +# Note: +# - Only documented variables are considered public interfaces. +# - Expects to be included from the source tree root directory. ifndef dpkg_architecture_mk_included dpkg_architecture_mk_included = yes diff --git a/scripts/mk/buildapi.mk b/scripts/mk/buildapi.mk index defed706e..f118177e2 100644 --- a/scripts/mk/buildapi.mk +++ b/scripts/mk/buildapi.mk @@ -1,5 +1,9 @@ # This Makefile fragment (since dpkg 1.22.0) defines the DPKG_BUILD_API # variable, that contains the package dpkg-build-api(7) level. +# +# Note: +# - Only documented variables are considered public interfaces. +# - Expects to be included from the source tree root directory. ifndef dpkg_buildapi_mk_included dpkg_buildapi_mk_included = yes diff --git a/scripts/mk/buildflags.mk b/scripts/mk/buildflags.mk index 11597002d..8f25e2df7 100644 --- a/scripts/mk/buildflags.mk +++ b/scripts/mk/buildflags.mk @@ -28,6 +28,9 @@ # You can also export them in the environment by setting # DPKG_EXPORT_BUILDFLAGS to a non-empty value. # +# Note: +# - Only documented variables are considered public interfaces. +# - Expects to be included from the source tree root directory. ifndef dpkg_buildflags_mk_included dpkg_buildflags_mk_included = yes diff --git a/scripts/mk/buildopts.mk b/scripts/mk/buildopts.mk index 734d55e02..21e0ecd8d 100644 --- a/scripts/mk/buildopts.mk +++ b/scripts/mk/buildopts.mk @@ -7,6 +7,10 @@ # $(DEB_BUILD_OPTIONS) "parallel=2" "parallel=" "" # $(DEB_BUILD_OPTION_PARALLEL) "2" "" unset # $(DEB_BUILD_OPTION_PARALLEL:%=-j%) "-j2" "" "" +# +# Note: +# - Only documented variables are considered public interfaces. +# - Expects to be included from the source tree root directory. ifndef dpkg_buildopts_mk_included dpkg_buildopts_mk_included = yes diff --git a/scripts/mk/buildtools.mk b/scripts/mk/buildtools.mk index def15c103..0a140521b 100644 --- a/scripts/mk/buildtools.mk +++ b/scripts/mk/buildtools.mk @@ -24,6 +24,10 @@ # # The variables are not exported by default. This can be changed by # defining DPKG_EXPORT_BUILDTOOLS. +# +# Note: +# - Only documented variables are considered public interfaces. +# - Expects to be included from the source tree root directory. ifndef dpkg_buildtools_mk_included dpkg_buildtools_mk_included = yes diff --git a/scripts/mk/default.mk b/scripts/mk/default.mk index 14e5be0cd..f465cbef7 100644 --- a/scripts/mk/default.mk +++ b/scripts/mk/default.mk @@ -1,5 +1,9 @@ # This Makefile fragment (since dpkg 1.16.1) includes all the Makefile # fragments that define variables that can be useful within debian/rules. +# +# Note: +# - Only documented variables are considered public interfaces. +# - Expects to be included from the source tree root directory. ifndef dpkg_default_mk_included dpkg_default_mk_included = yes diff --git a/scripts/mk/pkg-info.mk b/scripts/mk/pkg-info.mk index 658e4f675..375e429b0 100644 --- a/scripts/mk/pkg-info.mk +++ b/scripts/mk/pkg-info.mk @@ -17,6 +17,10 @@ # (since dpkg 1.18.8). # If it is undefined, the date of the latest changelog entry is used. # In both cases, the value is exported. +# +# Note: +# - Only documented variables are considered public interfaces. +# - Expects to be included from the source tree root directory. ifndef dpkg_pkg_info_mk_included dpkg_pkg_info_mk_included = yes diff --git a/scripts/mk/vendor.mk b/scripts/mk/vendor.mk index a8d29cbcc..7744b73cb 100644 --- a/scripts/mk/vendor.mk +++ b/scripts/mk/vendor.mk @@ -32,6 +32,10 @@ # ifeq ($(call dpkg_vendor_derives_from_v1,ubuntu),yes) # ... # endif +# +# Note: +# - Only documented variables are considered public interfaces. +# - Expects to be included from the source tree root directory. ifndef dpkg_vendor_mk_included dpkg_vendor_mk_included = yes -- Dpkg.Org's dpkg
