Document all undocumented fuctions

[disassembler]

Issue description

We need to document all functions in nixpkgs that are not currently documents.

Please put your username next to any you are working on and check the box when it's finished. Add more files here as you find them:

<nixpkgs/pkgs/build-support/trivial-builders.nix> @disassembler

• [x] runCommand
• [x] runCommandNoCC
• [x] writeTextFile
• [x] writeText
• [x] writeTextDir
• [x] writeScript
• [x] writeScriptBin
• [x] writeShellScriptBin
• [x] symlinkJoin
• [x] makeSetupHook
• [ ] writeReferencesToFile
• [x] linkFarm
• [x] requireFile
• [ ] copyPathToStore
• [ ] copyPathsToStore

<nixpkgs/pkgs/top-level/all-packages.nix>

• [ ] pkgs.fetchadc (@FPtje)
• [ ] pkgs.fetchbower (@FPtje)
• [ ] pkgs.fetchbzr (@FPtje)
• [ ] pkgs.fetchcvs (@FPtje)
• [ ] pkgs.fetchdarcs (@FPtje)
• [ ] pkgs.fetchfossil
• [ ] pkgs.fetchgit
• [ ] pkgs.fetchgitPrivate
• [ ] pkgs.fetchgitrevision
• [ ] pkgs.fetchgitLocal
• [ ] pkgs.fetchmtn
• [ ] pkgs.fetchMavenArtifact
• [ ] pkgs.fetchpatch
• [ ] pkgs.fetchs3
• [ ] pkgs.fetchsvn
• [ ] pkgs.fetchsvnrevision
• [ ] pkgs.fetchsvnssh
• [ ] pkgs.fetchhg
• [ ] pkgs.fetchurl
• [ ] pkgs.fetchRepoProject
• [ ] pkgs.fetchurlBoot
• [ ] pkgs.fetchzip
• [ ] pkgs.fetchFromGitHub @basvandijk
• [ ] pkgs.fetchFromBitbucket
• [ ] pkgs.fetchFromSavannah
• [ ] pkgs.fetchFromGitLab
• [ ] pkgs.fetchFromRepoOrCz
• [ ] pkgs.fetchNuGet
• [ ] pkgs.fetchgx
• [ ] pkgs.fetchegg
• [ ] pkgs.fetchmail

<nixpkgs/lib>

• [ ] lib.cleanSource @gilligan
• [ ] lib.genActions @gilligan (the whole file will be removed soon)
• [ ] lib.isOption @gilligan
• [ ] lib.mkOption @gilligan
• [ ] lib.mkEnableOption @gilligan
• [ ] lib.mergeDefaultOption
• [ ] lib.mergeOneOption @gilligan
• [ ] lib.getValues @gilligan
• [ ] lib.getFiles @gilligan
• [ ] lib.optionAttrSetToDocList' @gilligan
• [ ] lib.showOption @gilligan
• [ ] lib.showFiles @gilligan
• [ ] lib.unknownModule
• [ ] applyIfFunction
• [ ] packSubmodule
• [ ] mergeModules'
• [ ] mkIf
• [ ] mkAssert
• [ ] mkMerge
• [ ] mkOverride
• [ ] mkOptionDefault
• [ ] mkDefault
• [ ] mkForce
• [ ] mkVMOverride
• [ ] mkStrict
• [ ] mkFixStrictness
• [ ] mkOrder
• [ ] mkBefore
• [ ] mkAfter
• [ ] mkAliasAndWrapDefinitions
• [ ] doRename
• [ ] defaultMergeArg
• [ ] defaultMerge
• [ ] foldArgs
• [ ] defaultOverridableDelayableArgs
• [ ] uniqListExt
• [ ] condConcat
• [ ] lazyGenericClosure
• [ ] innerModifySumArgs
• [ ] modifySumArgs
• [ ] innerClosePropagation
• [ ] closePropagation
• [ ] mergeAttrsByFuncDefaults
• [ ] mergeAttrsByFuncDefaultsClean
• [ ] nixType
• [ ] addErrorContextToAttrs
• [ ] traceIf
• [ ] traceVal
• [ ] traceXMLVal
• [ ] traceXMLValMarked
• [ ] traceShowVal
• [ ] traceShowValMarked
• [ ] attrNamesToStr
• [ ] showVal
• [ ] strict
• [ ] getBin
• [ ] getLib
• [ ] getDev
• [ ] zipWithNames
• [ ] zip

<nixpkgs/pkgs/development/haskell-modules/lib.nix>

• [ ] all functions @roberth

<nixpkgs/nixos/lib>

• [ ] buildVM
• [x] make-channel.nix
• [ ] make-disk-image.nix pending major refactor according to copumpkin
• [ ] make-iso9660-image.nix
• [ ] make-squashfs.nix
• [ ] make-system-tarball.nix

<nixpkgs/nixos/lib/testing.nix>

• [ ] testDriver
• [ ] runTests
• [ ] makeTest
• [ ] runInMachine
• [ ] runInMachineWithX
• [ ] simpleTest

[gilligan]

I'm adding ??? for functions where I don't really have a clue how to properly document them.

[domenkozar]

What branch is this work in?

[roberth]

Mostly in pkgs-function-docs. I've put my haskell docs in a separate branch because I want peti to review it when I've covered all of the haskell lib.nix

[domenkozar]

Alright :) @disassembler do you plan to finish trivial-builders.nix? Happy to help and upstream that part of the work.

[roberth]

Hello all, it's been a while :). What do you think of upstreaming some documentation? I think partial documentation is better than no documentation, so I've created a PR for haskell.lib. What about the documentation that is hidden in a branch here?