summaryrefslogtreecommitdiffstats
path: root/pkgs
diff options
context:
space:
mode:
authorlassulus <lassulus@lassul.us>2018-10-27 13:15:27 +0200
committerjeschli <jeschli@gmail.com>2018-10-27 16:04:42 +0200
commitcbd5ff05f3baab463a2b8792baccbc3e8cd9afb6 (patch)
treea1bba75b9297fd93bcc25a3aa06483993dc60738 /pkgs
parentfc8a3802a0777a5f43a9a2fe0f5848ecaeb555a1 (diff)
writeC: documentation
Diffstat (limited to 'pkgs')
-rw-r--r--pkgs/default.nix23
1 files changed, 19 insertions, 4 deletions
diff --git a/pkgs/default.nix b/pkgs/default.nix
index bbfa3d3..4cc0df3 100644
--- a/pkgs/default.nix
+++ b/pkgs/default.nix
@@ -60,7 +60,6 @@ pkgs: oldpkgs: {
# Examples:
# writebash = makeScriptWriter { interpreter = "${pkgs.bash}/bin/bash"; }
# makeScriptWriter { interpreter = "${pkgs.dash}/bin/dash"; } "hello" "echo hello world"
- #
makeScriptWriter = { interpreter, check ? null }: name: text:
assert (with types; either absolute-pathname filename).check name;
pkgs.write (baseNameOf name) {
@@ -71,7 +70,7 @@ pkgs: oldpkgs: {
};
};
- # Take a name and specification and build a derivation out of it
+ # write takes a name and specification and build a derivation out of it
# Examples:
# write "name" { "/etc/test" = { text = "hello world"; }; }
#
@@ -89,7 +88,6 @@ pkgs: oldpkgs: {
# '';
# };
# }
- #
write = name: specs0:
let
env = filevars // { passAsFile = attrNames filevars; };
@@ -165,7 +163,6 @@ pkgs: oldpkgs: {
# writeBash "example" ''
# echo hello world
# ''
- #
writeBash = pkgs.makeScriptWriter {
interpreter = "${pkgs.bash}/bin/bash";
};
@@ -174,6 +171,24 @@ pkgs: oldpkgs: {
assert types.filename.check name;
pkgs.writeBash "/bin/${name}";
+ # writeC writes an executable c package called `name'
+ # to `destination' using `library'.
+ #
+ # Example:
+ # c = pkgs.writeC "hello-world-ncurses" { libraries = {ncurses = pkgs.ncurses;}; } ''
+ # #include <ncurses.h>
+ #
+ # int main()
+ # {
+ # initscr();
+ # printw("Hello World !!!");
+ # refresh();
+ # getch();
+ # endwin();
+ #
+ # return 0;
+ # }
+ # '';
writeC = name: {
destination ? "",
libraries ? {}