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