darlinghq / darling-docs

Darling Docs

Darling Docs

This repository stores the contents of https://docs.darlinghq.org

Generating a local copy

Download or compile mdbook from: https://github.com/rust-lang/mdBook/releases, or install a package from your Linux distribution if available.

Then run:

mdbook book.toml

The resulting book will be available as a set of HTML files under the newly-created "book" subdirectory.

darling-docs's Issues

Add xip

Install xip:

brew install thii/unxip/unxip

https://github.com/thii/Unxip

Link 'Contributing' on page 'Generating stubs' yields 404

Make $ non selectable in commands

All doc pages, example https://docs.darlinghq.org/contributing/generating-stubs.html
There are commands:

$ mkdir ~/bin

Either you double-click to select all line, or hit the copy floating icon, it copies the command as well the dollar symbol plus space $ (or % ).
This could be fixed making those 2 characters non-selectable for all commands.

Example URL: https://css-tricks.com/to-or-not-to-displaying-terminal-code-snippets/
Example code on that URL: brew install buttnugget (notice doesn't select $ ).
brew.sh homepage itself does this.

Failed to build lkm module on Ubuntu WSL

Hi, i tried to build the lkm module under Ubuntu WSL on a Windows host, but it failed with the following error :

Building the Linux kernel module
make[4]: Entering directory '/home/abp/darling/src/external/lkm'
Running kernel version is 4.19.128-microsoft-standard
rm -f darling-mach.mod.o
make -C /lib/modules/4.19.128-microsoft-standard/build M=/home/abp/darling/src/external/lkm modules
make[5]: Entering directory '/home/abp/darling/src/external/lkm'
make[5]: *** /lib/modules/4.19.128-microsoft-standard/build: No such file or directory.  Stop.
make[5]: Leaving directory '/home/abp/darling/src/external/lkm'
make[4]: *** [Makefile:346: default] Error 2
make[4]: Leaving directory '/home/abp/darling/src/external/lkm'
make[3]: *** [src/external/lkm/CMakeFiles/lkm.dir/build.make:58: src/external/lkm/CMakeFiles/lkm] Error 2
make[2]: *** [CMakeFiles/Makefile2:46426: src/external/lkm/CMakeFiles/lkm.dir/all] Error 2
make[1]: *** [CMakeFiles/Makefile2:46433: src/external/lkm/CMakeFiles/lkm.dir/rule] Error 2
make: *** [Makefile:15764: lkm] Error 2

Here is the information about the Ubuntu WSL :

uname -a
Linux ITEM-S39477 4.19.128-microsoft-standard #1 SMP Tue Jun 23 12:58:10 UTC 2020 x86_64 x86_64 x86_64 GNU/Linux
head -2 /etc/os-release
NAME="Ubuntu"
VERSION="20.04.1 LTS (Focal Fossa)"

Add command to load kernel module

On section Building and Installing, after sudo make lkm_install:

/darling/build$ sudo make lkm_install
[sudo] password for User:
Scanning dependencies of target lkm_install
Installing the Linux kernel module
make[4]: Entering directory '/darling/src/external/lkm'
Running kernel version is 5.11.0-34-generic
make -C /lib/modules/5.11.0-34-generic/build M=/darling/src/external/lkm modules_install
make[5]: Entering directory '/usr/src/linux-headers-5.11.0-34-generic'
  INSTALL /darling/src/external/lkm/darling-mach.ko
At main.c:160:
- SSL error:02001002:system library:fopen:No such file or directory: ../crypto/bio/bss_file.c:69
- SSL error:2006D080:BIO routines:BIO_new_file:no such file: ../crypto/bio/bss_file.c:76
sign-file: certs/signing_key.pem: No such file or directory
  DEPMOD  5.11.0-34-generic
Warning: modules_install: missing 'System.map' file. Skipping depmod.
make[5]: Leaving directory '/usr/src/linux-headers-5.11.0-34-generic'
make[4]: Leaving directory '/darling/src/external/lkm'
Built target lkm_install

Add command to guide:

lsmod | grep darling_mach || sudo modprobe darling_mach

Update dependencies to build for Fedora and CentOS

https://docs.darlinghq.org/build-instructions.html

Add ffmpeg-devel and remove libavcodec-free-devel libavformat-free-devel:

dnf install make cmake clang bison dbus-devel flex glibc-devel.i686 fuse-devel \
systemd-devel elfutils-libelf-devel cairo-devel freetype-devel.{x86_64,i686} \
libjpeg-turbo-devel.{x86_64,i686} fontconfig-devel.{x86_64,i686} libglvnd-devel.{x86_64,i686} \
mesa-libGL-devel.{x86_64,i686} mesa-libEGL-devel.{x86_64,i686} mesa-libGLU-devel.{x86_64,i686} \
libtiff-devel libxml2-devel libbsd-devel git git-lfs libXcursor-devel \
libXrandr-devel giflib-devel pulseaudio-libs-devel libxkbfile-devel \
openssl-devel llvm libcap-devel ffmpeg-devel

Add instructions about how to shutdown darling

I'm trying to unload darling kernel module, but no idea why doesn't work:

sudo rmmod darling_mach 
rmmod: ERROR: Module darling_mach is in use

Could be possible to add to guide how to perform such operation?

git: 'lfs' is not a git command.

Following docs:
https://docs.darlinghq.org/build-instructions.html

This command fails:

$ git lfs install
git: 'lfs' is not a git command. See 'git --help'.

The most similar command is
	log

Ubuntu 21.10 instructions

libavresample-dev isn't available for Ubuntu 21.10 for some reason.

how to install it on wsl ?

i want to install darling os to wsl how ??

Blog offline

Times out when trying to load the blog:
http://blog.darlinghq.org/

Error when building with xcode command line tools

Whenever I try to build a project with the xcode command line tools I get the following error:
Floating point exception: 8 (core dumped)
I already tried it on two different machines running Arch and Fedora.
The command I used was:
xcodebuild -list -project <project name>.xcodeproj

Estimate of disk space requirement

I know it is a drifting target, but it would be nice to know how much disk space / time is required . E.g. Some statement of the form:

• as of "year month", a full check out of the code takes 600MB(?); on my x core desktop, it takes roughly 2 hours to build, and the finished build directory is about 2GB in size; a "make install" consumes about 300MB. YMMV

This is sort of based on my experience with wine - but I suspect darling may be higher?

Build instructions for Arch & Manjaro cause issue due to newline

Following this guide:
https://docs.darlinghq.org/build-instructions.html

$ sudo pacman -S --needed make cmake clang flex bison icu fuse linux-headers gcc-multilib \
lib32-gcc-libs pkg-config fontconfig cairo libtiff python2 mesa llvm libbsd libxkbfile \ 
libxcursor libxext libxkbcommon libxrandr
warning: make-4.3-3 is up to date -- skipping
warning: cmake-3.21.2-2 is up to date -- skipping
warning: flex-2.6.4-3 is up to date -- skipping
warning: bison-3.7.6-1 is up to date -- skipping
warning: icu-69.1-1 is up to date -- skipping
warning: fuse2-2.9.9-4 is up to date -- skipping
warning: gcc-11.1.0-1 is up to date -- skipping
warning: lib32-gcc-libs-11.1.0-1 is up to date -- skipping
warning: pkgconf-1.7.3-1 is up to date -- skipping
warning: fontconfig-2:2.13.94-1 is up to date -- skipping
warning: cairo-1.17.4-5 is up to date -- skipping
warning: libtiff-4.3.0-1 is up to date -- skipping
warning: mesa-21.2.1-1 is up to date -- skipping
warning: libbsd-0.11.3-1 is up to date -- skipping
warning: libxkbfile-1.1.0-2 is up to date -- skipping
error: target not found:  
bash: libxcursor: command not found

It has to be done this way:

pamac install libavresample
sudo pacman -S --needed make cmake clang flex bison icu fuse linux-headers gcc-multilib lib32-gcc-libs pkg-config fontconfig cairo libtiff python2 mesa llvm libbsd libxkbfile libxcursor libxext libxkbcommon libxrandr

Put everything in a single line.
pamac can be installed in Arch and Manjaro. It's recommended to add such recommendation to Build guide.

Add uninstall before make install

Having a previous install can cause issues, so in section Now let's build Darling: I would recommend adding uninstall:

# Move into the cloned sources
cd darling 

# Make a build directory
mkdir build && cd build

# Configure the build
cmake ..

# Build and install Darling, remove previous install before upgrading
make
sudo ../tools/uninstall
sudo make install

https://docs.darlinghq.org/build-instructions.html

Improve explanation about Generating stubs section

Top section Generating stubs (https://docs.darlinghq.org/contributing/generating-stubs.html)

Says "A computer running macOS is required to run the stub generator."
It should clear out, that all below commands are meant to be run from within a running OS X itself, not mounting the root OS X volume under Linux (which probably can be done but commands will be other).

Missing libssl-dev on https://docs.darlinghq.org/build-instructions.html

On Debian 10 and Debian Testing
please add libssl-dev is need for build

Debian 10


$ sudo apt install cmake clang-6.0 bison flex xz-utils libfuse-dev libudev-dev pkg-config \
libc6-dev-i386 linux-headers-amd64 libcap2-bin git python2 libglu1-mesa-dev libcairo2-dev \
libgl1-mesa-dev libtiff5-dev libfreetype6-dev libxml2-dev libegl1-mesa-dev libfontconfig1-dev \
libbsd-dev libxrandr-dev libxcursor-dev libgif-dev libpulse-dev libavformat-dev libavcodec-dev \
libavresample-dev libdbus-1-dev libxkbfile-dev
Debian Testing


$ sudo apt install cmake clang-9 bison flex xz-utils libfuse-dev libudev-dev pkg-config \
libc6-dev-i386 linux-headers-amd64 libcap2-bin git python2 libglu1-mesa-dev libcairo2-dev \
libgl1-mesa-dev libtiff5-dev libfreetype6-dev libxml2-dev libegl1-mesa-dev libfontconfig1-dev \
libbsd-dev libxrandr-dev libxcursor-dev libgif-dev libpulse-dev libavformat-dev libavcodec-dev \
libavresample-dev libdbus-1-dev libxkbfile-dev

to

Debian 10


$ sudo apt install cmake clang-6.0 bison flex xz-utils libfuse-dev libudev-dev pkg-config \
libc6-dev-i386 linux-headers-amd64 libcap2-bin git python2 libglu1-mesa-dev libcairo2-dev \
libgl1-mesa-dev libtiff5-dev libfreetype6-dev libxml2-dev libegl1-mesa-dev libfontconfig1-dev \
libbsd-dev libxrandr-dev libxcursor-dev libgif-dev libpulse-dev libavformat-dev libavcodec-dev \
libavresample-dev libdbus-1-dev libxkbfile-dev libssl-dev
Debian Testing


$ sudo apt install cmake clang-9 bison flex xz-utils libfuse-dev libudev-dev pkg-config \
libc6-dev-i386 linux-headers-amd64 libcap2-bin git python2 libglu1-mesa-dev libcairo2-dev \
libgl1-mesa-dev libtiff5-dev libfreetype6-dev libxml2-dev libegl1-mesa-dev libfontconfig1-dev \
libbsd-dev libxrandr-dev libxcursor-dev libgif-dev libpulse-dev libavformat-dev libavcodec-dev \
libavresample-dev libdbus-1-dev libxkbfile-dev libssl-dev

copy button copies the dollar

https://docs.darlinghq.org/build-instructions.html
Copy button after "If you have already cloned Darling and would like to get the latest changes, do this in the source root:" copies the dollars:

$ git pull
$ git submodule init
$ git submodule update

When it should copy

git pull
git submodule init
git submodule update

Cannot open mnt namespace file: No such file or directory

OS: Ubuntu 23.10.
Error darlinghq/darling#1275:

$ darling shell
Bootstrapping the container with launchd...
Cannot open mnt namespace file: No such file or directory

Command listed here needs improvement:
https://docs.darlinghq.org/build-instructions.html#file-system-support

$ setsebool -P mmap_low_allowed 1
Cannot set persistent booleans, please try as root.

So now is an error:

$ sudo setsebool -P mmap_low_allowed 1
Cannot set persistent booleans without managed policy.