Re: About packaging (was: About packaging documentation)

[Zelphir Kaltstahl]

Hello Tobias!

(Reply is below.)

On 4/4/21 4:38 PM, Tobias Geerinckx-Rice wrote:
> Hi Zelphir,
>
> Zelphir Kaltstahl writes:
>> The guide at https://guix.gnu.org/manual/en/html_node/Building-from-Git.html
>> <https://guix.gnu.org/manual/en/html_node/Building-from-Git.html> does not
>> mention running a lone `make`.
>
> It says, after running ./configure:
>
>    Finally, you have to invoke 'make check' [...]
>
> This has the effect of running make [all], and then runs the test suite.
>
> Ignore it at your peril.  At most, substitute a ‘lone make’ for ‘make check’
> if you're feeling lucky and have previously run the test suite.
>
>> There is an error. Perhaps I need to run it in the some kind of minimalistic 
>> GNU
>> Guix env as I ran the configure and bootstrap in?
>
> Yep, *all* commands need to be run in the guix environment.  No need for
> ‘--ad-hoc make’ here as ‘make’ is already an input to guix.
>
>> Trying that (warning, long log ahead):
>
> [ 8< nom nom ]
>
>>   HELP2MAN doc/guix-time-machine.1
>>   HELP2MAN doc/guix-weather.1
>>   HELP2MAN doc/guix.1
>> make[2]: Leaving directory '/home/user/dev/guix'
>> make[1]: Leaving directory '/home/user/dev/guix'
>
> Success!  \o/
>
>> So now it should be build with the package definition I added known, I guess.
>> Now I try running guix build again:
>>
>> ~~~~
>> $ ./pre-inst-env guix build guile-fslib
>
> You need to run this inside the environment as well.  You keep leaving it;
> that won't work.  It used to work sometimes, years ago.
>
> Instead of tediously prefixing everything with ‘guix environment guix --’,
> just enter the environment once and stay there:
>
>  $ guix environment guix
>  $ ./bootstrap
>  $ ./configure --localstatedir=/var
>  $ make -j`nproc` check
>  $ ./pre-inst-env guix build guile-fslib
>  $ ...
>  $ exit # or C-d, to leave it when finished
>
> That's a rather standard way of doing things.  Does it work?
>
> Kind regards,
>
> T G-R


I did not know, that `make check` implies `make [all]`. Thanks for explaining!

That seems to have done it. The tests had one failure, but I continued with the
next commands anyway and I finally was able to install the package with `guix
install`. Here is the output of the command I ran:

(1) running the checks:

~~~~
$ guix environment guix
$ make check -j8
make  check-recursive
make[1]: Entering directory '/home/user/dev/guix'
Making check in po/guix
make[2]: Entering directory '/home/user/dev/guix/po/guix'
make[2]: Leaving directory '/home/user/dev/guix/po/guix'
Making check in po/packages
make[2]: Entering directory '/home/user/dev/guix/po/packages'
make[2]: Leaving directory '/home/user/dev/guix/po/packages'
make[2]: Entering directory '/home/user/dev/guix'
Compiling Scheme modules...
make  check-TESTS check-local
make[3]: Entering directory '/home/user/dev/guix'
make[3]: Nothing to be done for 'check-local'.
make[4]: Entering directory '/home/user/dev/guix'
PASS: tests/base16.scm
PASS: tests/base64.scm
PASS: tests/base32.scm
PASS: tests/bournish.scm
PASS: tests/accounts.scm
PASS: tests/cache.scm
PASS: tests/combinators.scm
PASS: tests/build-utils.scm
PASS: tests/boot-parameters.scm
PASS: tests/builders.scm
PASS: tests/cpio.scm
SKIP: tests/containers.scm
PASS: tests/cve.scm
PASS: tests/cpan.scm
PASS: tests/cran.scm
PASS: tests/discovery.scm
PASS: tests/debug-link.scm
PASS: tests/elpa.scm
PASS: tests/file-systems.scm
PASS: tests/git.scm
PASS: tests/glob.scm
SKIP: tests/crate.scm
PASS: tests/gem.scm
PASS: tests/gnu-maintenance.scm
PASS: tests/go.scm
PASS: tests/gremlin.scm
PASS: tests/grafts.scm
PASS: tests/git-authenticate.scm
PASS: tests/channels.scm
PASS: tests/import-utils.scm
PASS: tests/modules.scm
PASS: tests/monads.scm
PASS: tests/gexp.scm
PASS: tests/networking.scm
PASS: tests/opam.scm
PASS: tests/openpgp.scm
PASS: tests/graph.scm
SKIP: tests/hackage.scm
PASS: tests/pki.scm
PASS: tests/print.scm
PASS: tests/pack.scm
PASS: tests/processes.scm
PASS: tests/profiles.scm
SKIP: tests/pypi.scm
PASS: tests/records.scm
PASS: tests/scripts.scm
PASS: tests/search-paths.scm
PASS: tests/derivations.scm
PASS: tests/services/file-sharing.scm
PASS: tests/services.scm
PASS: tests/sets.scm
PASS: tests/nar.scm
PASS: tests/services/linux.scm
SKIP: tests/snix.scm
PASS: tests/status.scm
PASS: tests/size.scm
PASS: tests/store-deduplication.scm
PASS: tests/store-roots.scm
PASS: tests/substitute.scm
PASS: tests/swh.scm
SKIP: tests/syscalls.scm
PASS: tests/system.scm
PASS: tests/texlive.scm
PASS: tests/transformations.scm
PASS: tests/publish.scm
PASS: tests/store-database.scm
PASS: tests/ui.scm
SKIP: tests/upstream.scm
PASS: tests/uuid.scm
PASS: tests/utils.scm
PASS: tests/union.scm
PASS: tests/workers.scm
PASS: tests/inferior.scm
PASS: tests/challenge.scm
FAIL: tests/guix-git-authenticate.sh
PASS: tests/guix-hash.sh
PASS: tests/guix-download.sh
PASS: tests/packages.scm
PASS: tests/guix-pack-localstatedir.sh
PASS: tests/guix-build-branch.sh
PASS: tests/guix-package-aliases.sh
PASS: tests/guix-pack-relocatable.sh
PASS: tests/guix-archive.sh
PASS: tests/guix-authenticate.sh
PASS: tests/guix-pack.sh
SKIP: tests/guix-environment-container.sh
PASS: tests/store.scm
PASS: tests/guix-package-net.sh
PASS: tests/guix-describe.sh
PASS: tests/guix-repl.sh
PASS: tests/guix-lint.sh
PASS: tests/guix-daemon.sh
PASS: tests/guix-graph.sh
PASS: tests/guix-build.sh
PASS: tests/guix-environment.sh
PASS: tests/lint.scm
PASS: tests/guix-system.sh
PASS: tests/guix-package.sh
PASS: tests/guix-gc.sh
============================================================================
Testsuite summary for GNU Guix 1.2.0.13366-86617-dirty
============================================================================
# TOTAL: 1163
# PASS:  1131
# SKIP:  29
# XFAIL: 2
# FAIL:  1
# XPASS: 0
# ERROR: 0
============================================================================
See ./test-suite.log
Please report to bug-guix@gnu.org
============================================================================
make[4]: *** [Makefile:5478: test-suite.log] Error 1
make[4]: Leaving directory '/home/user/dev/guix'
make[3]: *** [Makefile:5586: check-TESTS] Error 2
make[3]: Leaving directory '/home/user/dev/guix'
make[2]: *** [Makefile:5835: check-am] Error 2
make[2]: Leaving directory '/home/user/dev/guix'
make[1]: *** [Makefile:5363: check-recursive] Error 1
make[1]: Leaving directory '/home/user/dev/guix'
make: *** [Makefile:5837: check] Error 2
~~~~

(I know, I can enter an environment first and then run all other things that
should be run inside the environment. Thanks for pointing it out though!)

(2)Trying to build:

~~~~
$ ./pre-inst-env guix build guile-fslib
substitute: updating substitutes from 'https://ci.guix.gnu.org'... 100.0%
1.0 MB will be downloaded:
   /gnu/store/sjh8jrp0cw2bxxnn9v5svlcsp1bwdyj5-curl-7.76.0-doc
   /gnu/store/1qd88064j2iicfnkxf5ylffmvisnsdlw-curl-7.76.0
substituting /gnu/store/sjh8jrp0cw2bxxnn9v5svlcsp1bwdyj5-curl-7.76.0-doc...
downloading from 
https://ci.guix.gnu.org/nar/lzip/sjh8jrp0cw2bxxnn9v5svlcsp1bwdyj5-curl-7.76.0-doc
 ...
 curl-7.76.0-doc  624KiB                                       1.7MiB/s 00:00 
[##################] 100.0%

substituting /gnu/store/1qd88064j2iicfnkxf5ylffmvisnsdlw-curl-7.76.0...
downloading from 
https://ci.guix.gnu.org/nar/lzip/1qd88064j2iicfnkxf5ylffmvisnsdlw-curl-7.76.0 
...
 curl-7.76.0  385KiB                                           1.1MiB/s 00:00 
[##################] 100.0%

4.3 MB will be downloaded:
   /gnu/store/531rwkb8m6yccq4l1mkrqxclrqwy0jj3-git-minimal-2.31.1
substituting /gnu/store/531rwkb8m6yccq4l1mkrqxclrqwy0jj3-git-minimal-2.31.1...
downloading from 
https://ci.guix.gnu.org/nar/lzip/531rwkb8m6yccq4l1mkrqxclrqwy0jj3-git-minimal-2.31.1
 ...
 git-minimal-2.31.1  4.1MiB                                    4.2MiB/s 00:01 
[##################] 100.0%

substitute: updating substitutes from 'https://ci.guix.gnu.org'... 100.0%
The following derivations will be built:
   /gnu/store/sggi94s3pmv9hsrfkn1fdxy31r6q2md9-guile-fslib-0.2.0.drv
   /gnu/store/iwcwrhw1yld1a5mb3vr8fsd4hqcsc9sx-guile-fslib-0.2.0-checkout.drv
2.9 MB will be downloaded:
   /gnu/store/4gffr26pb2zpasncanbp2ibamg1c5ms6-openssl-1.1.1k
   /gnu/store/3j0d42fws6xkmq5d5z4va807ph3l1330-module-import-compiled
   /gnu/store/lzsssshw32sxxlwgdhdjwpl7nhnk7fhs-module-import-compiled
The following grafts will be made:
   /gnu/store/fpq3zjj3kxg4z8wk5508jif2kzc708qg-git-minimal-2.31.1.drv
   /gnu/store/cdnrvbr03nhg8ly1msi65lz4m8k5l3cl-curl-7.76.0.drv
   /gnu/store/54zz5bh8zqjdjh5bp01z80484xizhaam-cyrus-sasl-2.1.27.drv
   /gnu/store/jcfn1b8gk2h6qzn0ibyy67hz00w0x5ma-openldap-2.4.57.drv
substituting 
/gnu/store/lzsssshw32sxxlwgdhdjwpl7nhnk7fhs-module-import-compiled...
downloading from 
https://ci.guix.gnu.org/nar/lzip/lzsssshw32sxxlwgdhdjwpl7nhnk7fhs-module-import-compiled
 ...
 module-import-compiled  211KiB                                836KiB/s 00:00 
[##################] 100.0%

substituting 
/gnu/store/3j0d42fws6xkmq5d5z4va807ph3l1330-module-import-compiled...
downloading from 
https://ci.guix.gnu.org/nar/lzip/3j0d42fws6xkmq5d5z4va807ph3l1330-module-import-compiled
 ...
 module-import-compiled  515KiB                                1.5MiB/s 00:00 
[##################] 100.0%

substituting /gnu/store/4gffr26pb2zpasncanbp2ibamg1c5ms6-openssl-1.1.1k...
downloading from 
https://ci.guix.gnu.org/nar/lzip/4gffr26pb2zpasncanbp2ibamg1c5ms6-openssl-1.1.1k
 ...
 openssl-1.1.1k  2.1MiB                                        3.8MiB/s 00:01 
[##################] 100.0%

applying 1 graft for 
/gnu/store/54zz5bh8zqjdjh5bp01z80484xizhaam-cyrus-sasl-2.1.27.drv ...
grafting '/gnu/store/macdf0y0id1h00y2zqy5sxzwn2v3qvdz-cyrus-sasl-2.1.27' -> 
'/gnu/store/p5hv40lkrafiralvpmy5f8m3jzlpbp77-cyrus-sasl-2.1.27'...
successfully built 
/gnu/store/54zz5bh8zqjdjh5bp01z80484xizhaam-cyrus-sasl-2.1.27.drv
applying 2 grafts for 
/gnu/store/jcfn1b8gk2h6qzn0ibyy67hz00w0x5ma-openldap-2.4.57.drv ...
grafting '/gnu/store/as9q61cn5jk9srknmfnlprmz2snqk597-openldap-2.4.57' -> 
'/gnu/store/zgbzw97lyw6nbq5id5qaznjz7vh3vf06-openldap-2.4.57'...
successfully built 
/gnu/store/jcfn1b8gk2h6qzn0ibyy67hz00w0x5ma-openldap-2.4.57.drv
applying 3 grafts for 
/gnu/store/cdnrvbr03nhg8ly1msi65lz4m8k5l3cl-curl-7.76.0.drv ...
grafting '/gnu/store/sjh8jrp0cw2bxxnn9v5svlcsp1bwdyj5-curl-7.76.0-doc' -> 
'/gnu/store/pbwrf3l1l0gqzsi4pmvfaxwgrwc4rvqy-curl-7.76.0-doc'...
grafting '/gnu/store/1qd88064j2iicfnkxf5ylffmvisnsdlw-curl-7.76.0' -> 
'/gnu/store/1jch0iqzk4i714xqc7l9lps57j9fb3sp-curl-7.76.0'...
successfully built /gnu/store/cdnrvbr03nhg8ly1msi65lz4m8k5l3cl-curl-7.76.0.drv
applying 2 grafts for 
/gnu/store/fpq3zjj3kxg4z8wk5508jif2kzc708qg-git-minimal-2.31.1.drv ...
grafting '/gnu/store/531rwkb8m6yccq4l1mkrqxclrqwy0jj3-git-minimal-2.31.1' -> 
'/gnu/store/7nvcw7m5625lg1yk261svqm88xz3b2fq-git-minimal-2.31.1'...
successfully built 
/gnu/store/fpq3zjj3kxg4z8wk5508jif2kzc708qg-git-minimal-2.31.1.drv
building 
/gnu/store/iwcwrhw1yld1a5mb3vr8fsd4hqcsc9sx-guile-fslib-0.2.0-checkout.drv...
guile: warning: failed to install locale
environment variable `PATH' set to 
`/gnu/store/378zjf2kgajcfd7mfr98jn5xyc5wa3qv-gzip-1.10/bin:/gnu/store/sf3rbvb6iqcphgm1afbplcs72hsywg25-tar-1.32/bin'
hint: Using 'master' as the name for the initial branch. This default branch 
name
hint: is subject to change. To configure the initial branch name to use in all
hint: of your new repositories, which will suppress this warning, call:
hint: 
hint:   git config --global init.defaultBranch <name>
hint: 
hint: Names commonly chosen instead of 'master' are 'main', 'trunk' and
hint: 'development'. The just-created branch can be renamed via this command:
hint: 
hint:   git branch -m <name>
Initialized empty Git repository in 
/gnu/store/0qv6zs2n0riiqnpkpyrpnwjq3qlj5dk1-guile-fslib-0.2.0-checkout/.git/
>From https://notabug.org/ZelphirKaltstahl/guile-fslib
 * tag               0.2.0      -> FETCH_HEAD
Note: switching to 'FETCH_HEAD'.

You are in 'detached HEAD' state. You can look around, make experimental
changes and commit them, and you can discard any commits you make in this
state without impacting any branches by switching back to a branch.

If you want to create a new branch to retain commits you create, you may
do so (now or later) by using -c with the switch command. Example:

  git switch -c <new-branch-name>

Or undo this operation with:

  git switch -

Turn off this advice by setting config variable advice.detachedHead to false

HEAD is now at eacdbb5 implement file-name procedure
successfully built 
/gnu/store/iwcwrhw1yld1a5mb3vr8fsd4hqcsc9sx-guile-fslib-0.2.0-checkout.drv
building /gnu/store/sggi94s3pmv9hsrfkn1fdxy31r6q2md9-guile-fslib-0.2.0.drv...
starting phase `set-SOURCE-DATE-EPOCH'
phase `set-SOURCE-DATE-EPOCH' succeeded after 0.0 seconds
starting phase `set-paths'
environment variable `PATH' set to 
`/gnu/store/v6f44zccwh9z5zk3pjlywjybbi8n2hjh-tar-1.32/bin:/gnu/store/ncydgq2znms5n1d2k5yqshhf58nsixwv-gzip-1.10/bin:/gnu/store/i8h2pcxqdq07ijm3ibkka8f4smn1w48v-bzip2-1.0.8/bin:/gnu/store/9860f1abqj8wjjnwl8a9v54pdcc3bhgf-xz-5.2.4/bin:/gnu/store/18hp7flyb3yid3yp49i6qcdq0sbi5l1n-guile-3.0.2/bin'
environment variable `GUILE_LOAD_PATH' unset
environment variable `GUILE_LOAD_COMPILED_PATH' unset
phase `set-paths' succeeded after 0.0 seconds
starting phase `set-locale-path'
phase `set-locale-path' succeeded after 0.0 seconds
starting phase `install-locale'
using 'en_US.utf8' locale for category "LC_ALL"
phase `install-locale' succeeded after 0.0 seconds
starting phase `unpack'
`/gnu/store/0qv6zs2n0riiqnpkpyrpnwjq3qlj5dk1-guile-fslib-0.2.0-checkout/logging.scm'
 -> `./logging.scm'
`/gnu/store/0qv6zs2n0riiqnpkpyrpnwjq3qlj5dk1-guile-fslib-0.2.0-checkout/todo.org'
 -> `./todo.org'
`/gnu/store/0qv6zs2n0riiqnpkpyrpnwjq3qlj5dk1-guile-fslib-0.2.0-checkout/list-utils.scm'
 -> `./list-utils.scm'
`/gnu/store/0qv6zs2n0riiqnpkpyrpnwjq3qlj5dk1-guile-fslib-0.2.0-checkout/fslib.scm'
 -> `./fslib.scm'
`/gnu/store/0qv6zs2n0riiqnpkpyrpnwjq3qlj5dk1-guile-fslib-0.2.0-checkout/string-utils.scm'
 -> `./string-utils.scm'
`/gnu/store/0qv6zs2n0riiqnpkpyrpnwjq3qlj5dk1-guile-fslib-0.2.0-checkout/.gitignore'
 -> `./.gitignore'
`/gnu/store/0qv6zs2n0riiqnpkpyrpnwjq3qlj5dk1-guile-fslib-0.2.0-checkout/README.md'
 -> `./README.md'
`/gnu/store/0qv6zs2n0riiqnpkpyrpnwjq3qlj5dk1-guile-fslib-0.2.0-checkout/file-reader.scm'
 -> `./file-reader.scm'
`/gnu/store/0qv6zs2n0riiqnpkpyrpnwjq3qlj5dk1-guile-fslib-0.2.0-checkout/LICENSE'
 -> `./LICENSE'
`/gnu/store/0qv6zs2n0riiqnpkpyrpnwjq3qlj5dk1-guile-fslib-0.2.0-checkout/file-system.scm'
 -> `./file-system.scm'
`/gnu/store/0qv6zs2n0riiqnpkpyrpnwjq3qlj5dk1-guile-fslib-0.2.0-checkout/test/test-string-utils.scm'
 -> `./test/test-string-utils.scm'
`/gnu/store/0qv6zs2n0riiqnpkpyrpnwjq3qlj5dk1-guile-fslib-0.2.0-checkout/test/test-list-utils.scm'
 -> `./test/test-list-utils.scm'
`/gnu/store/0qv6zs2n0riiqnpkpyrpnwjq3qlj5dk1-guile-fslib-0.2.0-checkout/test/test-fslib.scm'
 -> `./test/test-fslib.scm'
phase `unpack' succeeded after 0.0 seconds
starting phase `patch-usr-bin-file'
phase `patch-usr-bin-file' succeeded after 0.0 seconds
starting phase `patch-source-shebangs'
phase `patch-source-shebangs' succeeded after 0.0 seconds
starting phase `patch-generated-file-shebangs'
phase `patch-generated-file-shebangs' succeeded after 0.0 seconds
starting phase `build'
Compiling with Guile 3.0...
compile flags: ("-Wunbound-variable" "-Warity-mismatch" "-Wformat")
wrote 
`/gnu/store/2k3x0j6mvypjagam39dx89fd5yan7a3y-guile-fslib-0.2.0/lib/guile/3.0/site-ccache/./file-reader.go'
[ 1/ 9] Compiling...
logging.scm:11:24: warning: non-literal format string
wrote 
`/gnu/store/2k3x0j6mvypjagam39dx89fd5yan7a3y-guile-fslib-0.2.0/lib/guile/3.0/site-ccache/./logging.go'
[ 2/ 9] Compiling...
wrote 
`/gnu/store/2k3x0j6mvypjagam39dx89fd5yan7a3y-guile-fslib-0.2.0/lib/guile/3.0/site-ccache/./file-system.go'
wrote 
`/gnu/store/2k3x0j6mvypjagam39dx89fd5yan7a3y-guile-fslib-0.2.0/lib/guile/3.0/site-ccache/./list-utils.go'
[ 3/ 9] Compiling...
[ 4/ 9] Compiling...
wrote 
`/gnu/store/2k3x0j6mvypjagam39dx89fd5yan7a3y-guile-fslib-0.2.0/lib/guile/3.0/site-ccache/./string-utils.go'
[ 5/ 9] Compiling...
wrote 
`/gnu/store/2k3x0j6mvypjagam39dx89fd5yan7a3y-guile-fslib-0.2.0/lib/guile/3.0/site-ccache/./fslib.go'
[ 6/ 9] Compiling...
wrote 
`/gnu/store/2k3x0j6mvypjagam39dx89fd5yan7a3y-guile-fslib-0.2.0/lib/guile/3.0/site-ccache/./test/test-list-utils.go'
[ 7/ 9] Compiling...
wrote 
`/gnu/store/2k3x0j6mvypjagam39dx89fd5yan7a3y-guile-fslib-0.2.0/lib/guile/3.0/site-ccache/./test/test-string-utils.go'
[ 8/ 9] Compiling...
wrote 
`/gnu/store/2k3x0j6mvypjagam39dx89fd5yan7a3y-guile-fslib-0.2.0/lib/guile/3.0/site-ccache/./test/test-fslib.go'
[ 9/ 9] Compiling...
phase `build' succeeded after 1.7 seconds
starting phase `install-documentation'
phase `install-documentation' succeeded after 0.0 seconds
starting phase `patch-shebangs'
phase `patch-shebangs' succeeded after 0.0 seconds
starting phase `validate-documentation-location'
phase `validate-documentation-location' succeeded after 0.0 seconds
starting phase `delete-info-dir-file'
phase `delete-info-dir-file' succeeded after 0.0 seconds
starting phase `patch-dot-desktop-files'
phase `patch-dot-desktop-files' succeeded after 0.0 seconds
starting phase `install-license-files'
installing 1 license files from '.'
phase `install-license-files' succeeded after 0.0 seconds
starting phase `reset-gzip-timestamps'
phase `reset-gzip-timestamps' succeeded after 0.0 seconds
starting phase `compress-documentation'
phase `compress-documentation' succeeded after 0.0 seconds
successfully built 
/gnu/store/sggi94s3pmv9hsrfkn1fdxy31r6q2md9-guile-fslib-0.2.0.drv
/gnu/store/2k3x0j6mvypjagam39dx89fd5yan7a3y-guile-fslib-0.2.0
~~~~

(3) Installing it:

~~~~
$ ./pre-inst-env guix install guile-fslib
The following package will be installed:
   guile-fslib 0.2.0

The following derivation will be built:
   /gnu/store/p68szzk2dxpplsykdggczj38q0qs2hqk-profile.drv

building CA certificate bundle...
building fonts directory...
building directory of Info manuals...
building database for manual pages...
building profile with 1 package...
~~~~

(4) checking if it was installed:

~~~~
$ guix package -I
guile-fslib     0.2.0   out     
/gnu/store/2k3x0j6mvypjagam39dx89fd5yan7a3y-guile-fslib-0.2.0
~~~~

Yay! It finally installed!

So I think part of the things I did wrong was, that I thought, that the
`pre-inst-env` steps would be run outside of the environment created with `guix
environment guix`.

OK thank you all for helping me out with all this!

I am going to try to write it all down and share a link later.

Best regards,
Zelphir

-- 
repositories: https://notabug.org/ZelphirKaltstahl