Skip to content

Commit

Permalink
remove all traces of lib.mdDoc
Browse files Browse the repository at this point in the history
mdDoc has been removed from the upstream and is thus no longer supported.

Signed-off-by: Brian McGillion <[email protected]>
  • Loading branch information
brianmcgillion committed Dec 12, 2024
1 parent e88eb4a commit a80cd17
Show file tree
Hide file tree
Showing 3 changed files with 18 additions and 20 deletions.
1 change: 0 additions & 1 deletion docs/default.nix
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,6 @@ let
# TODO this hides the other modules (e.g. microvm.nix)
# But they are stilled passed as options modules ???
if lib.strings.hasPrefix "ghaf" x.name then x else x // { visible = false; };
markdownByDefault = true;
}).optionsCommonMark;
combinedSrc = runCommandLocal "ghaf-doc-src" { } ''
mkdir $out
Expand Down
23 changes: 11 additions & 12 deletions modules/hardware/common/shared-mem.nix
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,6 @@ let
mkMerge
mkIf
mkOption
mdDoc
types
;
in
Expand All @@ -26,22 +25,22 @@ in
enable = mkOption {
type = types.bool;
default = false;
description = mdDoc ''
description = ''
Enables shared memory communication between virtual machines (VMs)
'';
};
memSize = mkOption {
type = types.int;
default = 16;
description = mdDoc ''
description = ''
Specifies the size of the shared memory region, measured in
megabytes (MB)
'';
};
hugePageSz = mkOption {
type = types.str;
default = "2M";
description = mdDoc ''
description = ''
Specifies the size of the large memory page area. Supported kernel
values are 2 MB and 1 GB
'';
Expand All @@ -55,15 +54,15 @@ in
hostSocketPath = mkOption {
type = types.path;
default = "/tmp/ivshmem_socket"; # The value is hardcoded in the application
description = mdDoc ''
description = ''
Specifies the path to the shared memory socket, used by QEMU
instances for inter-VM memory sharing and interrupt signaling
'';
};
flataddr = mkOption {
type = types.str;
default = "0x920000000";
description = mdDoc ''
description = ''
Maps the shared memory to a physical address if set to a non-zero value.
The address must be platform-specific and arbitrarily chosen to avoid
conflicts with other memory areas, such as PCI regions.
Expand All @@ -72,29 +71,29 @@ in
vms_enabled = mkOption {
type = types.listOf types.str;
default = [ ];
description = mdDoc ''
description = ''
List of vms having access to shared memory
'';
};
enable_host = mkOption {
type = types.bool;
default = false;
description = mdDoc ''
description = ''
Enables the memsocket functionality on the host system
'';
};
instancesCount = mkOption {
type = types.int;
default =
if cfg.enable_host then (builtins.length cfg.vms_enabled) + 1 else builtins.length cfg.vms_enabled;
description = mdDoc ''
description = ''
Number of memory slots allocated in the shared memory region
'';
};
serverSocketPath = mkOption {
type = types.path;
default = "/run/user/${builtins.toString config.ghaf.users.accounts.uid}/memsocket-server.sock";
description = mdDoc ''
description = ''
Specifies the path of the listening socket, which is used by Waypipe
or other server applications as the output socket in server mode for
data transmission
Expand All @@ -103,7 +102,7 @@ in
clientSocketPath = mkOption {
type = types.path;
default = "/run/user/${builtins.toString config.ghaf.users.accounts.uid}/memsocket-client.sock";
description = mdDoc ''
description = ''
Specifies the location of the output socket, which will connected to
in order to receive data from AppVMs. This socket must be created by
another application, such as Waypipe, when operating in client mode
Expand All @@ -112,7 +111,7 @@ in
display = mkOption {
type = types.bool;
default = false;
description = mdDoc ''
description = ''
Enables the use of shared memory with Waypipe for Wayland-enabled
applications running on virtual machines (VMs), facilitating
efficient inter-VM communication
Expand Down
14 changes: 7 additions & 7 deletions modules/reference/hardware/jetpack/nvidia-jetson-orin/optee.nix
Original file line number Diff line number Diff line change
Expand Up @@ -6,15 +6,15 @@
xtest = lib.mkOption {
type = lib.types.bool;
default = false;
description = lib.mdDoc ''
description = ''
Adds OP-TEE's xtest and related TA/Plugins
'';
};

pkcs11-tool = lib.mkOption {
type = lib.types.bool;
default = false;
description = lib.mdDoc ''
description = ''
OpenSC pkcs11-tool, but for a convenience reasons \"pkcs11-tool-optee\" shell
script is created. It calls pkcs11-tool with "--module"-option set to
OP-TEE's PKCS#11 library.
Expand All @@ -30,23 +30,23 @@
enable = lib.mkOption {
type = lib.types.bool;
default = true;
description = lib.mdDoc ''
description = ''
Adds OP-TEE's PKCS#11 TA.
'';
};

authTeeIdentity = lib.mkOption {
type = lib.types.bool;
default = true;
description = lib.mdDoc ''
description = ''
Enable PKCS#11 TA's TEE Identity based authentication support
'';
};

lockPinAfterFailedLoginAttempts = lib.mkOption {
type = lib.types.bool;
default = true;
description = lib.mdDoc ''
description = ''
Locks correspondingly User or SO PIN when reaching maximum
failed authentication attemps (continous) limit
'';
Expand All @@ -55,7 +55,7 @@
heapSize = lib.mkOption {
type = lib.types.int;
default = 32768;
description = lib.mdDoc ''
description = ''
Defines PKCS11 TA heap size. Heap size has a direct
correlation to its secure storage size. Heap == Storage.
Expand All @@ -68,7 +68,7 @@
tokenCount = lib.mkOption {
type = lib.types.int;
default = 3;
description = lib.mdDoc ''
description = ''
PKCS#11 token count.
NOTE: Redefining token count might corrupt secure storage,
Expand Down

0 comments on commit a80cd17

Please sign in to comment.