MDS/openide
1
0
Fork 0
mirror of https://gitflic.ru/project/openide/openide.git synced 2026-09-27 10:03:11 +07:00
Code Issues Packages Projects Releases Wiki Activity

build scripts: javadoc updated

Browse Source
This commit is contained in:
nik
2016-09-15 11:12:04 +03:00
parent 0c87baf3c0
commit 9ae1af4112
1 changed files with 16 additions and 9 deletions
Download Patch File Download Diff File Expand all files Collapse all files
build/groovy/org/jetbrains/intellij/build/package.html
+16 -9
View File
@@ -1,7 +1,7 @@
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 3.2 Final//EN">
<html>
<body>
This package contains groovy scripts which build distributions of a product based on IntelliJ Platform.
This package contains groovy scripts which build distributions of products based on IntelliJ Platform.
<p>
If you want to build a product from sources locally, run the corresponding *.gant file from IntelliJ IDEA (e.g. dist.gant to build IDEA Community).
It makes sense to add {@linkplain org.jetbrains.intellij.build.BuildOptions#USE_COMPILED_CLASSES_PROPERTY '-Dintellij.build.use.compiled.classes=true'} to 'VM Options'
@@ -11,23 +11,30 @@ If you want to build a product from sources locally, run the corresponding *.gan
</p>
<p>
If you want to add a new module to an existing product, add its name to {@link org.jetbrains.intellij.build.ProductModulesLayout#platformApiModules
platformApiModules/platformImplementationModules}. If the module is part of IntelliJ Platform and needs to be include into all products
platformApiModules/platformImplementationModules}. If the module is part of IntelliJ Platform and needs to be included into all products
add its name to {@link org.jetbrains.intellij.build.CommunityRepositoryModules#PLATFORM_API_MODULES PLATFORM_API_MODULES/PLATFORM_IMPLEMENTATION_MODULES} list.
</p>
<p>
If you want to add a new plugin to an existing product, add its layout to {@link org.jetbrains.intellij.build.ProductProperties#allPlugins productProperties.allPlugins} list
(see {@link org.jetbrains.intellij.build.impl.PluginLayout#plugin PluginLayout.create} for details) and specify the main plugin module
in {@link org.jetbrains.intellij.build.ProductModulesLayout#bundledPluginModules productProperties.productLayout.bundledPluginModules} list.
If you want to add a new plugin to an existing product, specify the main plugin module in {@link org.jetbrains.intellij.build.ProductModulesLayout#bundledPluginModules productProperties.productLayout.bundledPluginModules} list.
If the plugin's layout isn't trivial, i.e. it consists of more than one module or bundle some project libraries
(see {@link org.jetbrains.intellij.build.impl.PluginLayout#plugin PluginLayout.create} for details) you also need to specify its layout in
the corresponding *_REPOSITORY_PLUGINS list ({@link org.jetbrains.intellij.build.CommunityRepositoryModules#COMMUNITY_REPOSITORY_PLUGINS COMMUNITY_REPOSITORY_PLUGINS} for plugins located in idea/community sources).
</p>
<p>
If you want to add a new library to the platform part of some product(s) you just need to add it to the dependencies list of one of modules included into {@link org.jetbrains.intellij.build.ProductModulesLayout the product layout}
with scope 'Compile' or 'Runtime'. If you don't want to add the library to dependencies you may copy it in the implementation of
{@link org.jetbrains.intellij.build.ProductProperties#copyAdditionalFiles copyAdditionalFiles} method for all products where it should be.
</p>
<p>
If you want to add a new library to distribution of some plugin you can either add it as a module library and it'll be bundled automatically
or define it as a project library and add to the plugin layout explicitly (see {@link org.jetbrains.intellij.build.impl.PluginLayout#plugin PluginLayout.create} for details)
</p>
<p>
If you want to build a new product, you need to define the following:
<ol>
<li>an implementation of {@link org.jetbrains.intellij.build.ProductProperties ProductProperties}, look at {@link org.jetbrains.intellij.build.IdeaCommunityProperties IdeaCommunityProperties}
for example.</li>
<li>a groovy script which creates a {@link org.jetbrains.intellij.build.BuildContext BuildContext} instance and calls {@link
org.jetbrains.intellij.build.BuildTasks#compileModulesAndBuildDistributions BuildTasks#compileModulesAndBuildDistributions} method</li>
<li>a gant file which adds the folder containing the created groovy classes to the classpath using {@link org.jetbrains.intellij.build.impl.BuildUtils#addToClassPath BuildUtils.addToClassPath}
method and run the groovy script via reflection.</li>
<li>a gant file which calls {@link org.jetbrains.intellij.build.BuildTasks#buildProduct BuildTasks.buildProduct} method</li>
</ol>
</body>
</html>