fritzkink
2023-12-27 706019354bab81fc3f01995caf1ae1a2dfa346cf
doc/makefile-targets.txt
@@ -1,4 +1,3 @@
This is a guide to explain various useful targets in Userland component
Makefiles.  There is a set of targets that all Makefiles must include, plus
some addtional targets that are there for convenience.
@@ -15,8 +14,8 @@
  automatically.  It is defined in $(WS_MAKE_RULES)/environment.mk which is
  included by $(WS_MAKE_RULES)/shares-macros.mk.  It uses the REQUIRE_PACKAGES
  macro contents to attempt to install any required packages in the current
  environment.  It should never by used by developers to update any public
  build machines as those are managed by dedicated staff.
  environment. To use this target user has to be assigned "Software Installation"
  or "Primary Administrator" profile.
download::
  This target is present in all Makefiles.  It can be used at the top level
@@ -53,16 +52,6 @@
  as internal interim targets to unpack source archives and apply patches to
  the unpacked source.
configure:
  This target is an optional target that can be included in component Makefiles
  to run the community source configuration phase of a component build.  It is
  typically defined in component Makefiles that make use of the
  $(WS_MAKE_RULES)/configure.mk Makefile fragment, but could be defined in
  others that include a source code configuration step.  It is not explicitly
  called during the build, but provides a convenient means of downloading,
  unpacking, patching, and "configuring" component source for building without
  actually compiling the bits.
build::
  This target must be present in all Makefiles.  It can be used at the top level
  to act across all components, or on an individual component basis.  It is
@@ -89,13 +78,25 @@
  by the inclusion of $(WS_MAKE_RULES)/prep.mk.  It will run the build steps
  necessary to pkglint the manifests for a component.
publish::
pre-publish::
  This target is present in all Makefiles.  It can be used at the top level
  to act across all components, or on an individual component basis.  It is
  automatically defined by including $(WS_MAKE_RULES)/ips.mk.  It depends
  on the previously described 'install' target and will perform a series of
  internal, intermediate steps to use the component package manifests to
  generate and publish packages for that component.
  generate and validate consistency of packages for that component.
  NOTE: The pre-publish target aims to help a recipe developer to make sure
  that the recipe can produce a valid package without actually pushing its
  bits into his or her repository (allows to experiment, saves some time, and
  avoids polluting the repository with known-bad code during development cycles).
publish::
  This target is present in all Makefiles.  It can be used at the top level
  to act across all components, or on an individual component basis.  It is
  automatically defined by including $(WS_MAKE_RULES)/ips.mk.  It depends
  on the previously described 'pre-publish' target and will actually publish
  packages for that component to the repository configured in $(WS_REPO).
clean::
  This target is present in all Makefiles.  It can be used at the top level
@@ -120,5 +121,35 @@
  be used to generate the set of REQUIRED_PACKAGES that is needed by the
  'pkgdepend resolve' portion of package generation and publication (publish
  target).  It automatically appends to the component Makefile, but the results
  should be
  manually verified.
  should be manually verified.
env-check::
  This target serves as an alias for component-environment-check target. It exists
  only for user convenience.
env-prep::
  This target serves as an alias for component-environment-prep target. It exists
  only for user convenience.
print-VAR
  This target will print contents of variable VAR and also provide information
  about variable origin and variable flavor.
print-value-VAR
  This target will print contents of variable VAR.
format
  This target will apply different refactoring rules to update the Makefile
  to the current style: deprecation of macros, use of new target, autoindent...
  The rules are implemented in the userland-component utility.
update
  This target will format the Makefile then bump the COMPONENT_REVISION variable
  if no VERSION value is provided. If a VERSION value is provided it will set
  the COMPONENT_VERSION to the given value and remove COMPONENT_REVISION.
  For some supported build style it may peform additional actions like:
  - infering the latest version if VERSION=latest is passed,
  - updating the archive checksum.
update-latest
  This target is a convenience shortcut for 'update VERSION=latest'.