Clone Tools
  • last updated a few seconds ago
Constraints: committers
Constraints: files
Constraints: dates
Convert user manual to be generated by Asciidoctor only

This change replaces all embedded Docbook syntax from the user manual.

Asciidoctor files are now converted directly to HTML and PDF.

It not only greatly simplifies the user manual generation pipeline, but also it makes it faster.

I did the following for all user manual pages:

- [x] Adjusted links to other manual pages, DSL docs, and Javadocs where necessary.

Fixed a couple dozen broken links at least.

- [x] Convert samples XML from docbook to asciidoctor syntax

- [x] Converted wide tables to a more flexible list-based display

Important contributor differences from now on:

- Users must use a `<file>.adoc#` prefix for all cross-reference links.

This is _required_ to achieve working links in all 3 outputs: multi-page user manual, single-page user manual, and PDF.

- The manual PDF is no longer themed, and no longer has the list of examples links in the TOC.

- File names were changed from camelCased to snake_case to have a crystal clear 1-1 mapping between source to output.

- Section reference verification is now handled by Asciidoctor verbose mode.

- The single-page user manual has the same navigation as the multi-page manual for now.

- [Common Asciidoctor extensions]( are now used by Gradle Guides and the User Manual, however, the the web assets (CSS, JS, etc) are not yet merged.

These extensions are responsible for injecting the navigation and styles.

The header/footer/navigation HTML can now be found under `subprojects/docs/src/main/resources`.

  1. … 401 more files in changeset.
Adjust documentation for {mutable -> configurable,}files{For -> }

  1. … 9 more files in changeset.
Update userguide for ProjectLayout.filesFor() and mutableFilesFor()

  1. … 9 more files in changeset.
Fix and improve minor issues in files chapter

  1. … 4 more files in changeset.
Improved nested specs example in files chapter

  1. … 8 more files in changeset.
Explain workaround for Ant default exclusions in files chapter

  1. … 2 more files in changeset.
Incorporate more feedback into files chapter

  1. … 11 more files in changeset.
Convert examples to tested samples

All the placeholder code examples in working with files are now tested samples

with the introduction of SamplesCopyIntegrationTest and


  1. … 24 more files in changeset.
Intermediate commit to update source tree

  1. … 8 more files in changeset.
Finish first draft of Working with Files update

  1. … 2 more files in changeset.
Fix tests

  1. … 4 more files in changeset.
Use doLast instead of left shift operator in docs

+review REVIEW-6236

  1. … 105 more files in changeset.
Use old API methods for task inputs and outputs

Will revert deprecation in next commit.

+review REVIEW-6038

  1. … 38 more files in changeset.
Revert "Temporarily reverting everything since 810f052813ea0835dc7e9d3eb87bca005815db64 for 3.0-milestone-1 release"

This reverts commit 506f8ce9d6dc1a81e8ff10575c512778ca2f382a.

  1. … 199 more files in changeset.
Temporarily reverting everything since 810f052813ea0835dc7e9d3eb87bca005815db64 for 3.0-milestone-1 release

  1. … 199 more files in changeset.
Bind task output files to properties

This change introduces a binding between task properties and output files. Output annotations automatically register property values to the corresponding property name.

The `TaskOutputs` API gained new methods with an `include` prefix that allow more flexible configuration of output properties, including specifying the property name to bind the files to. The old methods have been deprecated.

Properties that were not assigned a property name will be bound to a sequence of pseudo names like `$1`, `$2` etc.

+review REVIEW-6038

  1. … 41 more files in changeset.
Fix tests

Some leftover fixes for integration tests.

+review REVIEW-6038

  1. … 6 more files in changeset.
Release notes for filteringCharset on CopySpec

+review REVIEW-5907

  1. … 2 more files in changeset.
GRADLE-1267 add a filteringCharset property to the copy spec

The copy task (and all the other tasks based on a CopySpec) allow filtering the source files to transform them. But the charset used to read and write the files was always the platform default charset, which causes problem if, for example, the source files are encoded with UTF8 but the platform default charset is another one.

This commit allows specifying a charset to use when filtering the files using `filteringCharset = 'UTF8'` (for example).

Note that the name `filteringCharset` was chosen for this new property as specified in `design-docs/`.

  1. … 15 more files in changeset.
Allow closures passed to LineFilter to remove lines by returning null. - LineFilter no longer implicitly tracks end of file via nullity of transformedLine, but explicitly tracks state (normal, line skip, eof). - Content of copyTestResources/src/two/two.b was unused, so now contains data for line removal integration tests. - Adding an entirely new test file would have affected tests which check which files were copied.

  1. … 5 more files in changeset.
Tabs to spaces +review REVIEW-5060

  1. … 17 more files in changeset.
Full proofreading pass on user guide. * Fixed many small typos * Fixed many small grammar issues, requiring small rephrasing * Reworded many phrases to avoid problem with "literal"s being truncated at EOL * Added blank columns to some tables to avoid overwrites * Added newlines to code samples to avoid truncation * Edited all task dependency graphs to use UML "depends on" notation, with arrow from task to depended task, along with a mention of this in the introduction * Added info to "" to describe how to edit graph images * Fixed template link for API references * Ensured text uses "left double quote" and "right double quote" where appropriate * Made a handful of small actual content changes to emphasize points not fully covered * Changed some "p" elements to "para" * Changed some "thread" elements to "thead"

  1. … 137 more files in changeset.
Doc : improved Copy task VS copy() method chapter

  1. … 1 more file in changeset.
Fixed some problems with samples tests after the changes in the implicit tasks and dependency insight task.

  1. … 1 more file in changeset.
Update userguide and samples with information about using from task / from task.outputs

  1. … 1 more file in changeset.
Turn on deprecation checking for integration tests by default: disabled in a few cases - use GradleDistributionExecuter.ignoreDeprecationWarnings() in cases where warnings are still emitted in tests - Ignore idea.ConfigurationHooksTest.triggersBeforeAndWhenConfigurationHooks, since this test fails due to a bug - A few other tests still failing

  1. … 15 more files in changeset.
Renamed subprojects/gradle-(.+) to subprojects/$1

  1. … 6178 more files in changeset.