This is an automated email from the ASF dual-hosted git repository.
ahuber pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/isis.git
The following commit(s) were added to refs/heads/master by this push:
new 5ea407e0e7 ISIS-3041: notes on IDE build prereq.
5ea407e0e7 is described below
commit 5ea407e0e72c941ac7576458f12c5035745e9ba4
Author: Andi Huber <[email protected]>
AuthorDate: Fri Sep 23 07:41:05 2022 +0200
ISIS-3041: notes on IDE build prereq.
---
.../modules/ROOT/pages/merging-a-pull-request.adoc | 8 ++++----
.../components/conguide/modules/eclipse/pages/about.adoc | 12 ++++++++++++
.../components/conguide/modules/intellij/pages/about.adoc | 14 ++++++++++++++
3 files changed, 30 insertions(+), 4 deletions(-)
diff --git
a/antora/components/comguide/modules/ROOT/pages/merging-a-pull-request.adoc
b/antora/components/comguide/modules/ROOT/pages/merging-a-pull-request.adoc
index 1dc38299cb..eaafcbcafa 100644
--- a/antora/components/comguide/modules/ROOT/pages/merging-a-pull-request.adoc
+++ b/antora/components/comguide/modules/ROOT/pages/merging-a-pull-request.adoc
@@ -4,12 +4,12 @@
:Notice: Licensed to the Apache Software Foundation (ASF) under one or more
contributor license agreements. See the NOTICE file distributed with this work
for additional information regarding copyright ownership. The ASF licenses this
file to you under the Apache License, Version 2.0 (the "License"); you may not
use this file except in compliance with the License. You may obtain a copy of
the License at. http://www.apache.org/licenses/LICENSE-2.0 . Unless required by
applicable law or ag [...]
:page-partial:
-
-
-
-
The process for merging in github pull requests (so that they can be tested
locally before committing) has been scripted in the `github-pr.sh` script.
+NOTE: Alternatively, if you are confident using _git_ from within your IDE,
+consider the specific IDE setup guides
xref:conguide:eclipse:about.adoc[Eclipse]
+and xref:conguide:intellij:about.adoc[IntelliJ].
+
The script will merge the fork into a temporary branch, and then run a build.
Once you are happy, you can commit.
diff --git a/antora/components/conguide/modules/eclipse/pages/about.adoc
b/antora/components/conguide/modules/eclipse/pages/about.adoc
index e4f968c080..9697d04559 100644
--- a/antora/components/conguide/modules/eclipse/pages/about.adoc
+++ b/antora/components/conguide/modules/eclipse/pages/about.adoc
@@ -2,6 +2,8 @@
:Notice: Licensed to the Apache Software Foundation (ASF) under one or more
contributor license agreements. See the NOTICE file distributed with this work
for additional information regarding copyright ownership. The ASF licenses this
file to you under the Apache License, Version 2.0 (the "License"); you may not
use this file except in compliance with the License. You may obtain a copy of
the License at. http://www.apache.org/licenses/LICENSE-2.0 . Unless required by
applicable law or ag [...]
+== Code Style / Initial IDE Configuration
+
Additional configuration of Eclipse for contributors (and committers):
* Set up the link:{attachmentsdir}/Apache-Isis.importorder[import order]
@@ -12,3 +14,13 @@ Also:
* set up the link:{attachmentsdir}/Apache-code-style-template.xml[code style
templates]
* set up link:{attachmentsdir}/Apache-Isis-code-style-cleanup.xml[code style
cleanup]
+== Prepare for Build
+
+The project/artifact `isis-core-privileged` is required to be an _automatic
module_
+in the _Java Platform Module System_ (JPMS) sense. (It has unrestricted access
to the class-path
+but not the module-path.)
+
+WARNING: As of time of writing, _Eclipse_ does *not* support automatic module
name resolution
+for projects that are also *opened* in the IDE. Instead it will resolve such
module names
+only from *closed* projects, that previously had been built and installed via
_Maven_ to the
+local repository. (Typically `~/.m2/repository`).
\ No newline at end of file
diff --git a/antora/components/conguide/modules/intellij/pages/about.adoc
b/antora/components/conguide/modules/intellij/pages/about.adoc
index 60c21d52d3..8775b244a7 100644
--- a/antora/components/conguide/modules/intellij/pages/about.adoc
+++ b/antora/components/conguide/modules/intellij/pages/about.adoc
@@ -2,7 +2,21 @@
:Notice: Licensed to the Apache Software Foundation (ASF) under one or more
contributor license agreements. See the NOTICE file distributed with this work
for additional information regarding copyright ownership. The ASF licenses this
file to you under the Apache License, Version 2.0 (the "License"); you may not
use this file except in compliance with the License. You may obtain a copy of
the License at. http://www.apache.org/licenses/LICENSE-2.0 . Unless required by
applicable law or ag [...]
+== Code Style / Initial IDE Configuration
+
Additional configuration of IntelliJ for contributors (and committers).
* Set up the link:{attachmentsdir}/Apache-Isis-importorder.xml[import order].
+== Prepare for Build
+
+The project/artifact `isis-core-privileged` is required to be an _automatic
module_
+in the _Java Platform Module System_ (JPMS) sense. (It has unrestricted access
to the class-path
+but not the module-path.)
+
+WARNING: As of time of writing, _IntelliJ IDEA_ does *not* support automatic
module name resolution
+for projects that are also *opened* in the IDE. Instead it will resolve such
module names
+only from *ignored* projects, that previously had been built and installed via
_Maven_ to the
+local repository. (Typically `~/.m2/repository`).
+
+
