Files

Mario Fetka 46031df872 docs: consolidate scattered documentation into fewer larger files

Merge 15 files into 3 consolidated docs and update all cross-references:

- doc/NSS_IMPORT_NOTES.md: merges NSS_USERSPACE_ADAPTATION.md,
  NSS_PUBLIC_CORE_AUDIT.md, NSS_NAMESPACE_AUDIT.md
- doc/TOOLBOX_PLAN.md: merges TUI_TOOLBOX_PLAN.md, NWCORE_INI_PLAN.md
- doc/DIRECTORY_AND_ADMIN_PLAN.md: merges DIRECTORY_STACK_PLAN.md,
  NWADMIN_CLIENT_PLAN.md
- doc/librarys/README.md: inlines 7 one-page stubs (nwtui, nwssl, nwflaim,
  nwxflaim, nwmatrixssl, nwlibsodium, nwowfat), deletes stub subdirs
- REDESIGN.md: absorbs KERNEL_REFERENCE_AUDIT.md into the transport/SPX
  section; adds Table of Contents after the architecture status table
- CLAUDE.md, AI.md, doc/README.md, doc/librarys/nwfs/README.md:
  all cross-references updated to new file names

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>

2026-06-18 18:15:46 +02:00

README.md

docs: consolidate scattered documentation into fewer larger files

2026-06-18 18:15:46 +02:00

README.md

nwfs

nwfs is the Mars/NCP filesystem compatibility wrapper. It maps Mars wire requests, volume options and HostFS/OtherFS state to libnwnss provider calls. NSS semantics belong in libnwnss; persistence and host adaptation belong here.

Public include roots

Consumers should receive include/nwfs as an include root and keep NSS subdirectories in include names. Examples:

#include <quota.h>
#include <public/zXattr.h>
#include <include/nameSpace.h>
#include <comn/namespace/dosNSpace.h>
#include <comn/authsys/zasAuthModel.h>

Do not expose include/nwfs/public, include/nwfs/include, or similar subdirectories as standalone public include roots. The subdirectory is part of the include name.

Current scope

The active Mars-owned parts provide xattr metadata handling, quota helpers and filesystem tests. NSS namespace files are being imported bottom-up and are not all active yet.

API usage guidance

Mars code should prefer the active nwfs public headers for metadata and quota operations. NSS namespace internals should remain internal until the full Namespace, Beast and AdminVolume dependency chain is available.

NSS adaptation boundary

nwfs should expose NetWare/NSS semantics to Mars NWE, not embed a fake NSS filesystem. NSS xattr, metadata, namespace and rights code may be imported as provenance-preserving library code, but persistence must be mapped onto Mars userspace storage: host filesystem xattrs, Mars metadata files, and generated AdminVolume state.

See doc/NSS_IMPORT_NOTES.md for the project-wide adaptation boundary.