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

cc-wrapper: add hook #61553

Draft
wants to merge 1 commit into
base: staging
Choose a base branch
from
Draft

cc-wrapper: add hook #61553

wants to merge 1 commit into from

Conversation

LnL7
Copy link
Member

@LnL7 LnL7 commented May 15, 2019

This enables more detailed tracing of stdenv compile flags, for example
generating a compile_commands.json database for a c/c++ project.

$ NIX_CC_WRAPPER_HOOK=./cc-hook make

jq '{arguments: $ARGS.positional, directory: $ARGS.named.pwd, file: $ARGS.positional[] | select(endswith(".cc"))}' \
    -n --arg pwd "$PWD" --args -- "$@"
Motivation for this change
Things done
  • Tested using sandboxing (nix.useSandbox on NixOS, or option sandbox in nix.conf on non-NixOS)
  • Built on platform(s)
    • NixOS
    • macOS
    • other Linux distributions
  • Tested via one or more NixOS test(s) if existing and applicable for the change (look inside nixos/tests)
  • Tested compilation of all pkgs that depend on this change using nix-shell -p nix-review --run "nix-review wip"
  • Tested execution of all binary files (usually in ./result/bin/)
  • Determined the impact on package closure size (by running nix path-info -S before and after)
  • Assured whether relevant documentation is up to date
  • Fits CONTRIBUTING.md.

This enables more detailed tracing of stdenv compile flags, for example
generating a compile_commands.json database for a c/c++ project.

	$ NIX_CC_WRAPPER_HOOK=./cc-hook make

	jq '{arguments: $ARGS.positional, directory: $ARGS.named.pwd, file: $ARGS.positional[] | select(endswith(".cc"))}' \
	    -n --arg pwd "$PWD" --args -- "$@"
@matthewbauer
Copy link
Member

This might be okay, but I am still hoping for a more robust solution to this. These kind of hooks tend to get bit rotted very quickly (for example the nix-buffer stuff).

Has anyone tried generating a compilation db with cmake? I was hoping something like this would just work:

nix run nixpkgs.stdenv.cc nixpkgs.cmake -c cmake -DCMAKE_EXPORT_COMPILE_COMMANDS=ON

${extraBefore+"${extraBefore[@]}"} \
${params+"${params[@]}"} \
${extraAfter+"${extraAfter[@]}"}
fi
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Should compilation still happen when you provide this hook?

Copy link
Member Author

@LnL7 LnL7 May 16, 2019

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

For my hook yes, make would probably fail if nothing is actually built. But maybe there's some other usecase.

@LnL7
Copy link
Member Author

LnL7 commented May 16, 2019

I agree that it's a little bit out of place, but all the functionality I needed is already here. CMAKE_EXPORT_COMPILE_COMMANDS might work fine, but I have not found anything that works properly for make, etc. projects on all platforms.

@stale
Copy link

stale bot commented Jun 2, 2020

Thank you for your contributions.
This has been automatically marked as stale because it has had no activity for 180 days.
If this is still important to you, we ask that you leave a comment below. Your comment can be as simple as "still important to me". This lets people see that at least one person still cares about this. Someone will have to do this at most twice a year if there is no other activity.
Here are suggestions that might help resolve this more quickly:

  1. Search for maintainers and people that previously touched the
    related code and @ mention them in a comment.
  2. Ask on the NixOS Discourse. 3. Ask on the #nixos channel on
    irc.freenode.net.

@stale stale bot added the 2.status: stale https://github.com/NixOS/nixpkgs/blob/master/.github/STALE-BOT.md label Jun 2, 2020
@SuperSandro2000 SuperSandro2000 marked this pull request as draft November 28, 2020 05:01
@stale stale bot removed the 2.status: stale https://github.com/NixOS/nixpkgs/blob/master/.github/STALE-BOT.md label Nov 28, 2020
@stale
Copy link

stale bot commented Jun 3, 2021

I marked this as stale due to inactivity. → More info

@stale stale bot added the 2.status: stale https://github.com/NixOS/nixpkgs/blob/master/.github/STALE-BOT.md label Jun 3, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants