Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

add *.md files to makefile install #8484

Closed
wants to merge 1 commit into from

Conversation

gador
Copy link
Member

@gador gador commented Jun 9, 2023

Motivation

After the merge of #8084 the files in libstore now include the documentation *.md files. These files do not get copied by make, which in turn causes errors when linking those header files. (See e.g. zhaofengli/attic#56)

This came apparent after the update of nix stable on nixpkgs in NixOS/nixpkgs#233439 which causes a regression for me.

Context

This trivial change now includes the *.md files which fixes the issue. (Tested on current nixpkgs master). In my case (tested with attic, see issue linked above), I run into a different issue later on, but I guess it is unrelated. The follow up issue is

attic>   /nix/store/n4zhp46qjwmcd0az6pwqs5y6hg7x9ml1-nix-2.18.1-dev/include/nix/suggestions.hh:23:5: error: expected expression
attic>   /nix/store/n4zhp46qjwmcd0az6pwqs5y6hg7x9ml1-nix-2.18.1-dev/include/nix/suggestions.hh:23:5: error: use of undeclared identifier 'me'
attic>   /nix/store/n4zhp46qjwmcd0az6pwqs5y6hg7x9ml1-nix-2.18.1-dev/include/nix/suggestions.hh:23:5: error: use of undeclared identifier 'fields1'
attic>   /nix/store/n4zhp46qjwmcd0az6pwqs5y6hg7x9ml1-nix-2.18.1-dev/include/nix/suggestions.hh:23:5: error: use of undeclared identifier 'fields2'
attic>   /nix/store/n4zhp46qjwmcd0az6pwqs5y6hg7x9ml1-nix-2.18.1-dev/include/nix/suggestions.hh:23:5: error: expected expression
attic>   /nix/store/n4zhp46qjwmcd0az6pwqs5y6hg7x9ml1-nix-2.18.1-dev/include/nix/suggestions.hh:23:5: error: use of undeclared identifier 'me'
attic>   /nix/store/n4zhp46qjwmcd0az6pwqs5y6hg7x9ml1-nix-2.18.1-dev/include/nix/suggestions.hh:23:5: error: use of undeclared identifier 'fields1'
attic>   /nix/store/n4zhp46qjwmcd0az6pwqs5y6hg7x9ml1-nix-2.18.1-dev/include/nix/suggestions.hh:23:5: error: use of undeclared identifier 'fields2'
attic>   /nix/store/n4zhp46qjwmcd0az6pwqs5y6hg7x9ml1-nix-2.18.1-dev/include/nix/suggestions.hh:23:5: error: expected expression
attic>   /nix/store/n4zhp46qjwmcd0az6pwqs5y6hg7x9ml1-nix-2.18.1-dev/include/nix/suggestions.hh:23:5: error: use of undeclared identifier 'me'
attic>   /nix/store/n4zhp46qjwmcd0az6pwqs5y6hg7x9ml1-nix-2.18.1-dev/include/nix/suggestions.hh:23:5: error: use of undeclared identifier 'fields1'
attic>   /nix/store/n4zhp46qjwmcd0az6pwqs5y6hg7x9ml1-nix-2.18.1-dev/include/nix/suggestions.hh:23:5: error: use of undeclared identifier 'fields2'
attic>   /nix/store/n4zhp46qjwmcd0az6pwqs5y6hg7x9ml1-nix-2.18.1-dev/include/nix/content-address.hh:35:5: error: expected expression
attic>   /nix/store/n4zhp46qjwmcd0az6pwqs5y6hg7x9ml1-nix-2.18.1-dev/include/nix/content-address.hh:35:5: error: use of undeclared identifier 'me'
attic>   /nix/store/n4zhp46qjwmcd0az6pwqs5y6hg7x9ml1-nix-2.18.1-dev/include/nix/content-address.hh:35:5: error: use of undeclared identifier 'fields1'
attic>   /nix/store/n4zhp46qjwmcd0az6pwqs5y6hg7x9ml1-nix-2.18.1-dev/include/nix/content-address.hh:35:5: error: use of undeclared identifier 'fields2'
attic>   /nix/store/n4zhp46qjwmcd0az6pwqs5y6hg7x9ml1-nix-2.18.1-dev/include/nix/content-address.hh:35:5: error: expected expression
attic>   /nix/store/n4zhp46qjwmcd0az6pwqs5y6hg7x9ml1-nix-2.18.1-dev/include/nix/content-address.hh:35:5: error: use of undeclared identifier 'me'
attic>   /nix/store/n4zhp46qjwmcd0az6pwqs5y6hg7x9ml1-nix-2.18.1-dev/include/nix/content-address.hh:35:5: error: use of undeclared identifier 'fields1

(EDIT:
Please ignore the version identifier of nix. I overwrote it to test my fork which included the fix)

Checklist for maintainers

Maintainers: tick if completed or explain if not relevant

  • agreed on idea
  • agreed on implementation strategy
  • tests, as appropriate
    • functional tests - tests/**.sh
    • unit tests - src/*/tests
    • integration tests - tests/nixos/*
  • documentation in the manual
  • documentation in the internal API docs
  • code and comments are self-explanatory
  • commit message explains why the change was made
  • new feature or incompatible change: updated release notes

Priorities

Add 👍 to pull requests you find important.

@gador gador requested a review from thufschmitt as a code owner June 9, 2023 20:30
@thufschmitt
Copy link
Member

I'm a bit meh on that one as these .md files don't really have any good reason for being included from header files. It actually seems that only uds-remote-store does it (I suspect just by accident), and the relevant bits could easily be moved to the corresponding .cc file

@edolstra
Copy link
Member

Yeah the bug here is definitely including an .md file from a header. We don't want to install .md files.

@edolstra edolstra closed this in 87c66f6 Jun 12, 2023
zhaofengli added a commit to zhaofengli/attic that referenced this pull request Jun 13, 2023
Let's work around it downstream while we wait for a release.

Fixes #56.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants