Build manual with Meson #11224

Ericson2314 · 2024-07-31T04:40:44Z

Motivation

Meson for:

doc/manual
scripts
misc

Context

#2503

Depends on #11073
Depends on #11302

Priorities and Process

Add 👍 to pull requests you find important.

The Nix maintainer team uses a GitHub project board to schedule and track reviews.

L-as · 2024-07-31T13:35:00Z

What does this change compared to the other PRs? Wish GitHub supported dependencies in PRs natively.

Ericson2314 · 2024-07-31T17:08:44Z

@L-as Edited the description to be precise about it.

doc/manual/rl-next/build-hook-default.md

roberth · 2024-08-13T09:46:09Z

doc/manual/generate-deps.py

Oof, this sounds like a bug? Do meson or ninja have an issue about this we can follow?

roberth · 2024-08-13T09:47:41Z

doc/manual/generate-deps.py

+    assert '\\' not in path
+    assert ' ' not in path
+    assert '#' not in path
+    print("ignored:", path)


What does ignored mean?

roberth · 2024-08-13T09:49:58Z

doc/manual/json-to-tree.py

+This script is a helper for this project's Meson buildsystem, to replace its
+usage of `nix eval --write-to`. Writing a JSON object as a nested directory
+tree is more generic, easier to maintain, and far, far less cursed. Nix
+has 'good' support for JSON output. Let's just use it.


This seems like a motivation for a change, not actual documentation of what it does. Also not sure what curses have to do with this.

What is the file format and the result? Could you give an example so contributors can easily form an intuition for this program?

Thought: is this a File System Object?

roberth · 2024-08-13T09:56:41Z

doc/manual/package.nix

+  ];
+
+  # Hack for sake of the dev shell
+  passthru.baseNativeBuildInputs = [


Suggested change

passthru.baseNativeBuildInputs = [

passthru.externalNativeBuildInputs = [

This seems to be the defining feature, and what we want to have in the dev shell.
I can imagine an exception where we have an infrequently changed custom development tool that's actually local, but want to treat it as external for practicality, but we can revisit the name when we get there, and that's actually about the dev shell and not about this attribute anyway, so let's go with external for the package attribute?

roberth · 2024-08-13T10:00:05Z

doc/manual/package.nix

+    jq
+  ];
+
+  nativeBuildInputs = finalAttrs.passthru.baseNativeBuildInputs ++ [


thought: This could be factored out into mkMesonDerivation, or one of its layers, or maybe it should be called mkNixMesonDerivation or something because it's getting a bit specific.

roberth · 2024-08-13T10:29:05Z

src/libcmd/repl.cc

+    if (runNixPtr)
+        (*runNixPtr)(program, args, input);
+    else
+        throw Error("Cannot run '%s', no method of calling the Nix CLI provided", program);


Suggested change

throw Error("Cannot run '%s', no method of calling the Nix CLI provided", program);

throw Error("Cannot run '%s' because no method of calling the Nix CLI was provided. This is a configuration problem pertaining to how this program was built. See Nix 2.25 release notes.", program);

pet peeve: unidiomatic use of comma

let's give some context

Ideally we could be more specific and give a URL.

you could also use a semicolon to keep the brevity

roberth · 2024-08-13T10:40:39Z

src/nix/meson.build

+subdir('scripts')
+subdir('misc')


I would like these dependencies to be inverted if possible. I don't think the CLI build should be the final do-it-all derivation, because it means that changing these configs requires a CLI rebuild, making those files unnecessarily slow to iterate on.

roberth · 2024-08-13T10:44:22Z

src/nix/self-exe.cc

+    if (auto envOpt = getEnvNonEmpty("NIX_BIN_DIR"))
+        return fs::path{*envOpt} / std::string{getBinaryName()};
+
+    // Use some-times avaiable OS tricks to get to the path of this Nix, and try that


Suggested change

// Use some-times avaiable OS tricks to get to the path of this Nix, and try that

// Try OS tricks if available

roberth · 2024-08-13T10:45:26Z

src/nix/self-exe.hh

+ * Instead, we'll query the OS for the path to the current executable,
+ * using `getSelfExe()`.
+ *
+ * As a last resort, we resort to `PATH`. Hopefully we find a `nix`


Suggested change

* As a last resort, we resort to `PATH`. Hopefully we find a `nix`

* As a last resort, we rely on `PATH`. Hopefully we find a `nix`

roberth · 2024-08-13T10:47:54Z

tests/functional/meson.build

+        'PS4': '+(${BASH_SOURCE[0]-$0}:$LINENO) ',
+      },
+      # some tests take 15+ seconds even on an otherwise idle machine, on a loaded machine
+      # this can easily drive them to failure. give them more time, 5min rather than 30sec


Suggested change

# this can easily drive them to failure. give them more time, 5min rather than 30sec

# this can easily drive them to failure. give them more time than the default 30sec

Bitrot-proofing the comment.

dpulls · 2024-08-14T20:33:39Z

🎉 All dependencies have been resolved !

dpulls · 2024-08-27T17:32:05Z

🎉 All dependencies have been resolved !

Co-Authored-By: Qyriad <[email protected]> Co-Authored-By: eldritch horrors <[email protected]>

Ericson2314 · 2024-09-16T14:05:36Z

Added the commit that @haenoe contributed, thanks!

nixos-discourse · 2024-09-19T07:39:46Z

This pull request has been mentioned on NixOS Discourse. There might be relevant details there:

https://discourse.nixos.org/t/2024-09-18-nix-team-meeting-minutes-179/52361/1

Ericson2314 · 2024-09-23T22:09:25Z

Oh lovely, I don't think I got that eval error locally with Nix 2.18.

github-actions bot added documentation new-cli Relating to the "nix" command contributor-experience Developer experience for Nix contributors with-tests Issues related to testing. PRs with tests have some priority repl The Read Eval Print Loop, "nix repl" command and debugger labels Jul 31, 2024

tomberek mentioned this pull request Aug 4, 2024

Nix 2.24.1; nixVersions.latest: 2.23.3 -> 2.24.1 NixOS/nixpkgs#331720

Merged

13 tasks

Ericson2314 force-pushed the meson-misc branch from 775ce1e to 036f9ac Compare August 9, 2024 16:20

roberth reviewed Aug 12, 2024

View reviewed changes

doc/manual/rl-next/build-hook-default.md Outdated Show resolved Hide resolved

Ericson2314 force-pushed the meson-misc branch from 036f9ac to b79c558 Compare August 12, 2024 16:31

roberth reviewed Aug 13, 2024

View reviewed changes

Ericson2314 force-pushed the meson-misc branch from b79c558 to 496a558 Compare August 14, 2024 19:36

Ericson2314 force-pushed the meson-misc branch 2 times, most recently from 7688ec6 to 535f68a Compare August 19, 2024 15:20

Ericson2314 changed the title ~~Meson misc~~ Build manual with Meson Aug 19, 2024

Ericson2314 force-pushed the meson-misc branch from 535f68a to eb03773 Compare August 28, 2024 20:32

Ericson2314 mentioned this pull request Aug 28, 2024

Rewrite build system in Meson #2503

Open

Ericson2314 and others added 2 commits September 16, 2024 10:05

Meson the manual

cfad38c

Co-Authored-By: Qyriad <[email protected]> Co-Authored-By: eldritch horrors <[email protected]>

first ideas

3f776da

Ericson2314 force-pushed the meson-misc branch from aad71b9 to 3f776da Compare September 16, 2024 14:05

Ericson2314 added 4 commits September 18, 2024 15:16

Merge remote-tracking branch 'upstream/master' into meson-misc

434c70f

Rearrange manual meson so it evaluates

570b25c

WIP docs

fb330e1

Hacky get it build

26cccc7

Merge remote-tracking branch 'upstream/master' into meson-misc

70a991e

Ericson2314 added 2 commits September 23, 2024 17:50

Hacky fixes to the meson of the manual build

5a3926a

Fix bug with manual build in shell

9a5cad8

See if this fixes eval error in CI

2e059ac

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Build manual with Meson #11224

Build manual with Meson #11224

Ericson2314 commented Jul 31, 2024 •

edited

Loading

L-as commented Jul 31, 2024 •

edited

Loading

Ericson2314 commented Jul 31, 2024

roberth Aug 13, 2024

roberth Aug 13, 2024

roberth Aug 13, 2024

roberth Aug 13, 2024

roberth Aug 13, 2024

roberth Aug 13, 2024

roberth Aug 13, 2024

L-as Aug 13, 2024

roberth Aug 13, 2024

roberth Aug 13, 2024

roberth Aug 13, 2024

roberth Aug 13, 2024

dpulls bot commented Aug 14, 2024

dpulls bot commented Aug 27, 2024

Ericson2314 commented Sep 16, 2024

nixos-discourse commented Sep 19, 2024

Ericson2314 commented Sep 23, 2024

	passthru.baseNativeBuildInputs = [
	passthru.externalNativeBuildInputs = [

	throw Error("Cannot run '%s', no method of calling the Nix CLI provided", program);
	throw Error("Cannot run '%s' because no method of calling the Nix CLI was provided. This is a configuration problem pertaining to how this program was built. See Nix 2.25 release notes.", program);

	// Use some-times avaiable OS tricks to get to the path of this Nix, and try that
	// Try OS tricks if available

	* As a last resort, we resort to `PATH`. Hopefully we find a `nix`
	* As a last resort, we rely on `PATH`. Hopefully we find a `nix`

	# this can easily drive them to failure. give them more time, 5min rather than 30sec
	# this can easily drive them to failure. give them more time than the default 30sec

		subdir('scripts')
		subdir('misc')

Build manual with Meson #11224

Are you sure you want to change the base?

Build manual with Meson #11224

Conversation

Ericson2314 commented Jul 31, 2024 • edited Loading

Motivation

Context

Priorities and Process

L-as commented Jul 31, 2024 • edited Loading

Ericson2314 commented Jul 31, 2024

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

dpulls bot commented Aug 14, 2024

dpulls bot commented Aug 27, 2024

Ericson2314 commented Sep 16, 2024

nixos-discourse commented Sep 19, 2024

Ericson2314 commented Sep 23, 2024

Ericson2314 commented Jul 31, 2024 •

edited

Loading

L-as commented Jul 31, 2024 •

edited

Loading