From d11f7216a4dde7bf3deb8a295e46e1621380fb02 Mon Sep 17 00:00:00 2001 From: Jonah Graham Date: Thu, 23 Jan 2020 14:13:14 -0500 Subject: [PATCH] [releng] Document regenHelp profile Change-Id: If7d62e71ec45cff1d84700fa73e4d9810427965f --- README.md | 15 ++++++++++++++- 1 file changed, 14 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 776118ec6bf..c653ace970c 100644 --- a/README.md +++ b/README.md @@ -63,7 +63,20 @@ Requires verify phase of maven to run, i.e. will not run with `mvn package` even Runs the production steps of the build. This profile can only be run on the CDT CI machines as access to Eclipse key signing server is needed to sign the jars. -### Profiles +#### regenHelp + +Some of the help systems in Eclipse CDT require the `regenHelp` profile to rebuild their HTML from the source documents. For example, to regenerate the help +for Autotools or Meson do: + +``` +mvn generate-resources -DuseSimrelRepo -f build/org.eclipse.cdt.meson.docs -PregenHelp +``` + +``` +mvn generate-resources -DuseSimrelRepo -f build/org.eclipse.cdt.autotools.docs -PregenHelp +``` + +### Properties There are a number of properties (-D to mvn) to control the behaviour of the build. Refer to the pom.xml for the full list. Many of the properties are not intended to be set at the command