summaryrefslogtreecommitdiff
path: root/libcmark-gfm/README-DEV
diff options
context:
space:
mode:
Diffstat (limited to 'libcmark-gfm/README-DEV')
-rw-r--r--libcmark-gfm/README-DEV18
1 files changed, 18 insertions, 0 deletions
diff --git a/libcmark-gfm/README-DEV b/libcmark-gfm/README-DEV
new file mode 100644
index 0000000..dbf398b
--- /dev/null
+++ b/libcmark-gfm/README-DEV
@@ -0,0 +1,18 @@
+This document describes how libcmark-gfm was packaged for build2. In
+particular, this understanding will be useful when upgrading to a new upstream
+version. See ../README-DEV for general notes on cmark-gfm packaging.
+
+Symlink the required upstream files and directories into libcmark-gfm/:
+
+$ ln -s ../../upstream/src libcmark-gfm
+
+Note that we unable to generate cmark-gfm_version.h directly from the template
+as it is included as "cmark-gfm_version.h" in upstream's source code, which
+makes impossible using the header-generating machinery. That's why we create
+libcmark-gfm/cmark-gfm_version.h that includes <libcmark-gfm/version.h> that
+we auto-generate from upstream's src/cmark-gfm_version.h.in.
+
+Use libcmark-gfm/config.h.in.orig for creating libcmark-gfm/config.h,
+defining/undefining macros introduced with #cmakedefine.
+
+Create cmark-gfm_export.h defining CMARK_GFM_EXPORT macro.