MM-COMMON-PREPARE(1)

📦
version 1.0.8 · 7 versions
, in arch rolling, fedora 43, fedora 44, ubuntu stonking

💖 MM-COMMON-PREPARE 💖

okay bestie, so you're a C++ binding module and you wanna hang out with mm-common and Autotools? say less. the manual name is mm-common-prepare and this is literally the whole vibe.

✨ NAME ✨

mm-common-prepare — Prepare a C++ binding module to use mm-common and Autotools

🌸 SYNOPSIS 🌸

mm-common-prepare [OPTION]... [SOURCE-DIR]

🦋 DESCRIPTION 🦋

Run mm-common-prepare and it literally just copies the mm-common build support files into the source tree of a C++ binding module. that's the whole job. it's giving personal assistant. 🫶

but where exactly do those files land? plot twist: it depends on special macros in your configure.ac file. so the location is influenced, not random.

AC_CONFIG_AUX_DIR([AUX-DIR])

The Automake include files get placed into the AUX-DIR subdirectory of the top-level source directory. and if AC_CONFIG_AUX_DIR isn't specified at all? no worries, the files just chill at the top-level of the module's source tree. main character placement honestly.

MM_CONFIG_DOCTOOL_DIR([DOCTOOL-DIR])

If the MM_CONFIG_DOCTOOL_DIR macro is called with an explicit DOCTOOL-DIR argument, then the common utilities needed for generating and installing the reference documentation of a C++ binding module get copied to that named subdirectory. 💅

But — and this is the important part — if MM_CONFIG_DOCTOOL_DIR is not used, or it doesn't specify a DOCTOOL-DIR argument, then mm-common-prepare will not copy the documentation utility files into the module's source tree. Instead, it's assumed the module depends on mm-common and can just use the installed documentation utilities that come with it. lowkey iconic of it to not duplicate work.

If no SOURCE-DIR argument has been specified on the command line, the current working directory will be used. yes bestie, it defaults to where you already are. cozy.

👑 OPTIONS 👑

  • -c, --copy — copy files instead of creating symbolic links to them
  • -f, --force — forcefully replace existing files or symbolic links
  • --help — display a help message and exit
  • --version — show version information and exit

💀 EXIT STATUS 💀

The exit status is 0 if OK, or 1 if an error occurred. no in-between, no drama, just binary. slay.

🎀 FILES 🎀

The build support files currently copied by mm-common-prepare are listed below. manifest moment.

Automake include files copied to AUX-DIR:

compile-binding.am
dist-changelog.am
doc-reference.am
generate-binding.am

Documentation utilities copied to DOCTOOL-DIR:

doc-install.pl
doc-postprocess.pl
doxygen.css
doxygen-extra.css
tagfile-to-devhelp2.xsl

🔥 SEE ALSO 🔥

  • autoreconf(1), mm-common-get(1)
  • /usr/share/doc/mm-common/README
  • /usr/share/doc/mm-common/skeletonmm.tar.xz or /usr/share/doc/mm-common/skeletonmm.tar.gz
ngl, if you're setting up a fresh module, go peek at the skeleton tarball. it's giving template energy. 🌈

and that's a wrap, bestie!! this was mm-common-prepare from mm-common 1.0.8, dated 2014-08-13, brought to you by the good people at GNOME. periodt. 💜✨

📦 where this page comes from