userspace: add additional script documentation
We have several scripts used by the build system related
to generating code for system calls, privileged mode stacks,
kernel object metadata, and application shared memory
partitions. Add some overview documentation for each.
Signed-off-by: Andrew Boie <andrew.p.boie@intel.com>
diff --git a/scripts/gen_syscalls.py b/scripts/gen_syscalls.py
index 957bf14..53423ed 100755
--- a/scripts/gen_syscalls.py
+++ b/scripts/gen_syscalls.py
@@ -4,6 +4,25 @@
#
# SPDX-License-Identifier: Apache-2.0
+"""
+Script to generate system call invocation macros
+
+This script parses the system call metadata JSON file emitted by
+parse_syscalls.py to create several files:
+
+- A file containing weak aliases of any potentially unimplemented system calls,
+ as well as the system call dispatch table, which maps system call type IDs
+ to their handler functions.
+
+- A header file defing the system call type IDs, as well as function
+ prototypes for all system call handler functions.
+
+- A directory containing header files. Each header corresponds to a header
+ that was identified as containing system call declarations. These
+ generated headers contain the inline invocation functions for each system
+ call in that header.
+"""
+
import sys
import re
import argparse
