Skip to content

Commit

Permalink
Merge pull request #27179 Documentation cleanup for Gradle 8.5
Browse files Browse the repository at this point in the history
### Details
This is a Documentation change ONLY.

### Context
Clean up based on feedback from @ljacomet for Gradle 8.5

Co-authored-by: Laura Kassovic <lkassovic@gradle.com>
  • Loading branch information
bot-gradle and lkasso committed Nov 28, 2023
2 parents a26cec5 + 877fd19 commit 1548184
Show file tree
Hide file tree
Showing 7 changed files with 10 additions and 8 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -18,8 +18,6 @@
As a build author, you define tasks and dependencies between tasks.
Gradle guarantees that these tasks will execute in order of their dependencies.

image::author-gradle-1.png[]

Your build scripts and plugins configure this dependency graph.

For example, if your project tasks include `build`, `assemble`, `createDocs`, your build script(s) can ensure that they are executed in the order `build` -> `assemble` -> `createDoc`.
Expand All @@ -42,6 +40,8 @@ Both plugins and build scripts contribute to the task graph via the <<tutorial_u

A Gradle build has three distinct phases.

image::author-gradle-1.png[]

Gradle runs these phases in order:

Phase 1. Initialization::
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -64,6 +64,8 @@ It is roughly structured as follows:
<7> Distributions downloaded by the <<gradle_wrapper.adoc#gradle_wrapper,Gradle Wrapper>>.
<8> Global <<build_environment.adoc#sec:gradle_configuration_properties,Gradle configuration properties>>.

Consult the <<directory_layout.adoc#dir:gradle_user_home,Gradle Directories reference>> to learn more.

[[dir:project_root]]
== Project Root directory

Expand Down Expand Up @@ -104,7 +106,7 @@ The anatomy of a typical project root directory looks as follows:
<8> Usually, a project is organized into one or multiple subprojects.
<9> Each subproject has its own Gradle build script.

Consult the <<directory_layout.adoc#directory_layout,Gradle Directories reference>> to learn more.
Consult the <<directory_layout.adoc#dir:project_root,Gradle Directories reference>> to learn more.

[.text-right]
**Next Step:** <<intro_multi_project_builds.adoc#intro_multi_project_builds,Learn how to structure Multi-Project Builds>> >>
Original file line number Diff line number Diff line change
Expand Up @@ -45,9 +45,9 @@ The directory structure should look as follows:
├── gradlew
├── gradlew.bat
├── settings.gradle.kts // <1>
├── subproject-one
├── sub-project-1
│ └── build.gradle.kts // <2>
└── subproject-two
└── sub-project-2
└── build.gradle.kts // <2>
----
<1> The `settings.gradle.kts` file should include all subprojects.
Expand Down Expand Up @@ -76,7 +76,7 @@ The rest of a project path is a colon-separated sequence of project names, where

[source]
----
:subproject-one
:sub-project-1
----

You can see the project paths when running `gradle projects`:
Expand All @@ -88,8 +88,8 @@ Root project 'project'
------------------------------------------------------------
Root project 'project'
+--- Project ':subproject-one'
\--- Project ':subproject-two'
+--- Project ':sub-project-1'
\--- Project ':sub-project-2'
----

Project paths usually reflect the filesystem layout, but there are exceptions.
Expand Down
Binary file modified subprojects/docs/src/docs/userguide/img/author-gradle-1.png
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified subprojects/docs/src/docs/userguide/img/author-gradle-5.png
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified subprojects/docs/src/docs/userguide/img/gradle-basic-9.png
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 1548184

Please sign in to comment.