~sircmpwn/hare-dev

2 2

[PATCH hare] place empty README files in modules for docs

Details
Message ID
<20231216020922.41223-1-rebelgeek@blainsmith.com>
DKIM signature
missing
Download raw message
Modules such as net::ip, net::tcp, and net::udp do not appear on
https://docs.harelang.org/net so this merely adds empty README files to
modules that have it missing so HTML docs get generated for them.

Rather than filling in documentation for each module I opted to place
empty files to get them to at least show up and let module maintainers
fill them in as they see fit.

Fixes: https://todo.sr.ht/~sircmpwn/hare/911
Signed-off-by: Blain Smith <rebelgeek@blainsmith.com>
---
 crypto/sha1/README   | 0
 crypto/sha256/README | 0
 hare/unit/README     | 0
 linux/keyctl/README  | 0
 linux/timerfd/README | 0
 linux/vdso/README    | 0
 net/ip/README        | 0
 net/tcp/README       | 0
 net/udp/README       | 0
 sort/cmp/README      | 0
 unix/hosts/README    | 0
 unix/passwd/README   | 0
 12 files changed, 0 insertions(+), 0 deletions(-)
 create mode 100644 crypto/sha1/README
 create mode 100644 crypto/sha256/README
 create mode 100644 hare/unit/README
 create mode 100644 linux/keyctl/README
 create mode 100644 linux/timerfd/README
 create mode 100644 linux/vdso/README
 create mode 100644 net/ip/README
 create mode 100644 net/tcp/README
 create mode 100644 net/udp/README
 create mode 100644 sort/cmp/README
 create mode 100644 unix/hosts/README
 create mode 100644 unix/passwd/README

diff --git a/crypto/sha1/README b/crypto/sha1/README
new file mode 100644
index 00000000..e69de29b
diff --git a/crypto/sha256/README b/crypto/sha256/README
new file mode 100644
index 00000000..e69de29b
diff --git a/hare/unit/README b/hare/unit/README
new file mode 100644
index 00000000..e69de29b
diff --git a/linux/keyctl/README b/linux/keyctl/README
new file mode 100644
index 00000000..e69de29b
diff --git a/linux/timerfd/README b/linux/timerfd/README
new file mode 100644
index 00000000..e69de29b
diff --git a/linux/vdso/README b/linux/vdso/README
new file mode 100644
index 00000000..e69de29b
diff --git a/net/ip/README b/net/ip/README
new file mode 100644
index 00000000..e69de29b
diff --git a/net/tcp/README b/net/tcp/README
new file mode 100644
index 00000000..e69de29b
diff --git a/net/udp/README b/net/udp/README
new file mode 100644
index 00000000..e69de29b
diff --git a/sort/cmp/README b/sort/cmp/README
new file mode 100644
index 00000000..e69de29b
diff --git a/unix/hosts/README b/unix/hosts/README
new file mode 100644
index 00000000..e69de29b
diff --git a/unix/passwd/README b/unix/passwd/README
new file mode 100644
index 00000000..e69de29b
-- 
2.34.1
Details
Message ID
<CXS0CJEMHO1T.256QT9NSOUV6Y@eiger>
In-Reply-To
<20231216020922.41223-1-rebelgeek@blainsmith.com> (view parent)
DKIM signature
missing
Download raw message
i think we should generate documentation for modules without READMEs
Details
Message ID
<N61X5S.4LU8LTCR1L59@blainsmith.com>
In-Reply-To
<CXS0CJEMHO1T.256QT9NSOUV6Y@eiger> (view parent)
DKIM signature
missing
Download raw message
That is fine with me. I am happy to take a pass at actually filling out
the README files with something and sending another patch.
Reply to thread Export thread (mbox)