From: John Haugabook <johnhaugab...@gmail.com>
This patch covers the steps to build the html files that are excluded from
htdocs. It points to the instructions on building newlib-cygwin, and steps
to extract copies of the built html files to the cloned htdocs repo. The
sandbox tool in the support repo includes these steps on extracting the
newlib html docs to the htdocs cloned repo. Visit
https://github.com/jhauga/patch-newlib-cygwin-faq/tree/reproduce-local-site/sandbox#readme
for more details on the process.
Signed-off-by: John Haugabook <johnhaugab...@gmail.com>
---
winsup/doc/faq-resources.xml | 13 +++++++++++++
1 file changed, 13 insertions(+)
diff --git a/winsup/doc/faq-resources.xml b/winsup/doc/faq-resources.xml
index 4ef6f70bd..abe3f50f3 100644
--- a/winsup/doc/faq-resources.xml
+++ b/winsup/doc/faq-resources.xml
@@ -96,5 +96,18 @@ and configure the default <filename>httpd.conf</filename>
accordingly.
CustomLog "[path_for]/cygwin-htdocs/access.log" common
</screen>
</para>
+
+<para>To edit the documentation pages for the site clone
<literal>newlib-cygwin</literal>,
+and edit the relevant file(s) in <filename>winsup\doc</filename>. After
+editing see <ulink
url="https://cygwin.com/faq.html#faq.programming.building-cygwin";>newlib-cygwin
install</ulink>,
+and follow the instructions there. After building the docs, return to the
+root of the cloned site and run:
+<screen>
+ $ mkdir -p "doc/preview/cygwin-api" "doc/preview/cygwin-ug-net"
"doc/preview/faq"
+ $ cp -r
[path_for]/newlib-cygwin/build/x86_64-pc-cygwin/winsup/doc/cygwin-api/*html
doc/preview/cygwin-api
+ $ cp -r
[path_for]/newlib-cygwin/build/x86_64-pc-cygwin/winsup/doc/cygwin-ug-net/*html
doc/preview/cygwin-ug-net
+ $ cp -r
[path_for]/newlib-cygwin/build/x86_64-pc-cygwin/winsup/doc/faq/*html
doc/preview/faq
+</screen>
+</para>
</answer></qandaentry>
</qandadiv>
--
2.49.0.windows.1
