all: remove misc mentions of autotools in docs

This commit is contained in:
Jan Vaclav
2024-08-22 13:53:58 +02:00
parent c6de9b8f1b
commit 4db1829bc7
11 changed files with 24 additions and 134 deletions

View File

@@ -19,8 +19,8 @@ Regenerate the yml by running `ci-fairy generate-template`.
There are also tests for checking that the yml is correct:
1) run `tools/check-gitlab-ci.sh`
2) run `make check-local-gitlab-ci`, which runs 1). This also
runs as part of `make check`.
2) run `meson test check-local-gitlab-ci`, which runs 1). This also
runs as part of `meson test`.
In both cases, the test is skipped if `ci-fairy` is not in the path.
Install the correct `ci-fairy` version.

View File

@@ -256,14 +256,13 @@ maintained by the upstream maintainers. There you find builds of latest `main` a
Unit Tests
----------
We have plenty of unit tests. Run them with `make check` or
`meson test -C build`.
We have plenty of unit tests. Run them with `meson test -C build`.
Note that some files in the source tree are both generated and commited
to git. That means, certain changes to the code also affect these generated
files. The unit test fail in that case, to indicate that the generated
files no longer match what is commited to git.
You can also automatically regenerate the files by running `NM_TEST_REGENERATE=1 make check`.
You can also automatically regenerate the files by running `NM_TEST_REGENERATE=1 meson test`.
Note that test-client requires working translation.
See the [comment](src/tests/client/test-client.py#L14)
for how to configure it.

View File

@@ -252,10 +252,10 @@ Versioning scheme (version numbers are called MAJOR.MINOR.MICRO):
When doing a release, follow this process:
1. Ensure that `NEWS` file is up to date.
2. Increment the version in `configure.ac`, commit and tag the commit. Example:
2. Increment the version in `meson.build`, commit and tag the commit. Example:
`git tag -s 1.2.8 -m 'Tag 1.2.8'`.
3. Ensure that you are on the right commit and create the tarball:
`git clean -fdx && ./autogen.sh && make distcheck`
`git clean -fdx && meson setup build && cd build && meson dist`
4. Upload the tarball: `scp ./*-*.tar.xz "$user@master.gnome.org:"`
5. Login to `master.gnome.org` and run `ftpadmin install`.
Ensure the new tarballs show up at https://download.gnome.org/sources/

View File

@@ -18,9 +18,9 @@ usage() {
echo " -f|--force: force build, even if working directory is not clean and has local modifications"
echo " -c|--clean: run \`git-clean -fdx :/\` before build"
echo " -S|--srpm: only build the SRPM"
echo " -g|--git: create tarball from current git HEAD (skips make dist)"
echo " -g|--git: create tarball from current git HEAD (skips meson dist)"
echo " -Q|--quick: only create the distribution tarball, without running checks"
echo " -N|--no-dist: skip creating the source tarball if you already did \`make dist\`"
echo " -N|--no-dist: skip creating the source tarball if you already did \`meson dist\`"
echo " -w|--with \$OPTION: pass --with \$OPTION to rpmbuild. For example --with debug"
echo " -W|--without \$OPTION: pass --without \$OPTION to rpmbuild. For example --without debug"
echo " -s|--snapshot TEXT: use TEXT as the snapshot version for the new package (overwrites \$NM_BUILD_SNAPSHOT environment)"

View File

@@ -1,7 +1,7 @@
#!/bin/bash
# Run configure/meson for NetworkManager in a way similar to how an RPM build does it.
# The effect is, that if you do `make install`, that it will overwrite the files that
# The effect is, that if you do `meson install`, that it will overwrite the files that
# you'd usually get by installing the NetworkManager RPM. Also, it means you can afterwards
# systemctl restart NetworkManager.
@@ -33,7 +33,7 @@ usage() {
echo "$ $0 [-m|--meson <builddir>] [-s|--show] [-B|--no-build] [-h|--help]"
echo ""
echo "Configure NetworkManager in a way that is similar to when building"
echo "RPMs of NetworkManager for Fedora/RHEL. The effect is that \`make install\`"
echo "RPMs of NetworkManager for Fedora/RHEL. The effect is that \`meson install\`"
echo "will overwrite the files in /usr that you installed via the package management"
echo "systemd. Also, subsequent \`systemctl restart NetworkManager\` works."
echo "You don't want to do this on your real system, because it messes up your"

View File

@@ -2,10 +2,9 @@
project(
'NetworkManager', 'c',
# NOTE: When incrementing version also:
# - add corresponding NM_VERSION_x_y_z macros in
# "src/libnm-core-public/nm-version-macros.h.in"
# - update number in configure.ac
# NOTE: When incrementing version also add corresponding
# NM_VERSION_x_y_z macros in
# "src/libnm-core-public/nm-version-macros.h.in"
version: '1.51.0',
license: 'GPL2+',
default_options: [

View File

@@ -19,18 +19,14 @@ from __future__ import print_function
#
# For that, you'd setup your system correctly (see SETUP below) and then simply:
#
# $ NM_TEST_REGENERATE=1 make check-local-tests-client
# # Or `NM_TEST_REGENERATE=1 make check -j 10`
# $ meson -Ddocs=true --prefix=/tmp/nm1 build
# $ ninja -C build
# $ ninja -C build install
# $ NM_TEST_REGENERATE=1 ninja -C build test
# $ git diff ... ; git add ...
# # The previous step regenerated the expected output. Review the changes
# # and consider whether they are correct. Then commit the changes to git.
#
# With meson, you can do
# $ meson -Ddocs=true --prefix=/tmp/nm1 build
# $ ninja -C build
# $ ninja -C build install
# $ NM_TEST_REGENERATE=1 ninja -C build test
#
# Beware that you need to install the sources, and beware to choose a prefix that doesn't
# mess up your system (see SETUP below).
#
@@ -52,7 +48,7 @@ from __future__ import print_function
# # Ensure that the built nmcli has Polish locale working. If not,
# # you probably need to first `make install` the application at the
# # correct prefix. Take care to configure the build with the desired
# # prefix, like `./configure --prefix=/opt/tmp`. Usually, you want to avoid
# # prefix, like `meson setup build --prefix=/opt/tmp`. Usually, you want to avoid
# # using /usr as prefix, because that might overwrite files from your
# # package management system.
#

View File

@@ -15,60 +15,8 @@ so that core dumps get written to file. Afterwards, restore with
from /usr/lib/sysctl.d/50-coredump.conf.
For example, configure NetworkManager with
$ ./configure \
--enable-address-sanitizer=no \
--enable-compile-warnings=yes \
--enable-concheck \
--enable-config-plugin-ibft=yes \
--enable-gtk-doc \
--enable-ifcfg-rh=yes \
--enable-ifcfg-suse \
--enable-ifnet \
--enable-ifupdown=yes \
--enable-introspection \
--enable-json-validation=yes \
--enable-maintainer-mode \
--enable-more-logging \
--enable-more-warnings=error \
--enable-ovs=yes \
--enable-polkit=yes \
--enable-teamdctl=yes \
--enable-undefined-sanitizer=no \
--enable-vala=yes \
--enable-wimax \
--localstatedir=/var \
--prefix=/opt/test \
--sysconfdir=/etc \
--with-config-dhcp-default=internal \
--with-config-dns-rc-manager-default=auto \
--with-consolekit=yes \
--with-consolekit=yes \
--with-crypto=nss \
--with-dhclient=yes \
--with-dhcpcanon=yes \
--with-dhcpcd=yes \
--with-iwd=yes \
--with-libnm-glib=yes \
--with-modem-manager-1 \
--with-netconfig=/bin/nowhere/netconfig \
--with-nm-cloud-setup=yes \
--with-nmcli=yes \
--with-nmtui=yes \
--with-ofono=yes \
--with-resolvconf=/bin/nowhere/resolvconf \
--with-session-tracking=systemd \
--with-suspend-resume=systemd \
--with-systemd-logind=yes \
--with-valgrind=yes \
--enable-tests="${NM_BUILD_TESTS:-yes}" \
--with-more-asserts="${NM_BUILD_MORE_ASSERTS:-1000}" \
"${NM_CONFIGURE_OTPS[@]}"
Test with:
$ systemctl stop NetworkManager; /opt/test/sbin/NetworkManager --debug 2>&1 | tee -a /tmp/nm-log.txt
Or better, configure with `contrib/fedora/rpm/configure-for-system.sh`,
subsequent `make && make install` will overwrite your system's NetworkManager,
Configure NetworkManager with `contrib/fedora/rpm/configure-for-system.sh`,
subsequent `meson install` will overwrite your system's NetworkManager,
and you can test it with `systemctl daemon-reload ; systemctl restart NetworkManager`.
Run NM-ci tests after creating eth1 with

View File

@@ -3,60 +3,8 @@
find NetworkManager bind mounted at {{BASEDIR_NM}}
run `nm-env-prepare.sh setup --idx 1` to setup test interfaces
For example, configure NetworkManager with
$ ./configure \
--enable-address-sanitizer=no \
--enable-compile-warnings=yes \
--enable-concheck \
--enable-config-plugin-ibft=yes \
--enable-gtk-doc \
--enable-ifcfg-rh=yes \
--enable-ifcfg-suse \
--enable-ifnet \
--enable-ifupdown=yes \
--enable-introspection \
--enable-json-validation=yes \
--enable-maintainer-mode \
--enable-more-logging \
--enable-more-warnings=error \
--enable-ovs=yes \
--enable-polkit=yes \
--enable-teamdctl=yes \
--enable-undefined-sanitizer=no \
--enable-vala=yes \
--enable-wimax \
--localstatedir=/var \
--prefix=/opt/test \
--sysconfdir=/etc \
--with-config-dhcp-default=internal \
--with-config-dns-rc-manager-default=auto \
--with-consolekit=yes \
--with-consolekit=yes \
--with-crypto=nss \
--with-dhclient=yes \
--with-dhcpcanon=yes \
--with-dhcpcd=yes \
--with-iwd=yes \
--with-libnm-glib=yes \
--with-modem-manager-1 \
--with-netconfig=/bin/nowhere/netconfig \
--with-nm-cloud-setup=yes \
--with-nmcli=yes \
--with-nmtui=yes \
--with-ofono=yes \
--with-resolvconf=/bin/nowhere/resolvconf \
--with-session-tracking=systemd \
--with-suspend-resume=systemd \
--with-systemd-logind=yes \
--with-valgrind=yes \
--enable-tests="${NM_BUILD_TESTS:-yes}" \
--with-more-asserts="${NM_BUILD_MORE_ASSERTS:-1000}" \
"${NM_CONFIGURE_OTPS[@]}"
Test with:
$ systemctl stop NetworkManager; /opt/test/sbin/NetworkManager --debug 2>&1 | tee -a /tmp/nm-log.txt
Or better, if using Fedora, configure with `contrib/fedora/rpm/configure-for-system.sh`,
subsequent `make && make install` will overwrite your system's NetworkManager,
Configure NetworkManager with `contrib/fedora/rpm/configure-for-system.sh`,
subsequent `meson install` will overwrite your system's NetworkManager,
and you can test it with `systemctl daemon-reload ; systemctl restart NetworkManager`.
Run NM-ci tests after creating eth1 with

View File

@@ -23,7 +23,7 @@ set -e
# - with command "journal", additional arguments that are passed to journalctl.
#
# It bind mounts the current working directory inside the container.
# You can run `make install` and run tests.
# You can run `meson install` and run tests.
# There is a script nm-env-prepare.sh to generate a net1 interface for testing.
#
# This will bind-mount the NetworkManager working tree inside the container (and symlink

View File

@@ -23,7 +23,7 @@ set -e
# NetworkManager directories:
#
# The NetworkManager root directory is mounted in the VM as a filesystem share.
# You can run `make install` and run tests.
# You can run `meson install` and run tests.
#
# Create a symlink ./.git/NetworkManager-ci, to share the CI directory too.
#