working_with_files.adoc

Clone Tools
  • last updated a few seconds ago
Constraints
Constraints: committers
 
Constraints: files
Constraints: dates
Update docs to use `ObjectFactory.fileCollection()` instead of `ProjectLayout.configurableFiles()`.

  1. … 4 more files in changeset.
Doc updates: deprecations in AbstractArchiveTask

This commit contains the userguide and javadoc updates following the

deprecations in AbstractArchiveTask.

Samples are also updated to no longer use any deprecated API.

Issue #8217

  1. … 24 more files in changeset.
Changed 'user guide' to 'user manual' in a bunch of user visible places.

  1. … 22 more files in changeset.
Merge branch 'release'

  1. … 3 more files in changeset.
Add tests for samples in Ant migration chapter

  1. … 36 more files in changeset.
Merge pull request #6835 from gradle/dont-use-cwd

Try to clarify danger of using `new File()`

De-incubate pre 4.0 things in userguide

and for command line arguments

  1. … 17 more files in changeset.
Try to clarify danger of using `new File()`

I feel like ", which could be anywhere" was a little ambiguous and the caution

message didn't properly explain why not to use `new File()`. I also added the

caution to the section on `files()` in case readers see that before the one on

single file paths.

Merge branch 'master' into doc/working-with-files

fix issues after Paul Merlin's second review

Signed-off-by: jnizet <jb@ninja-squad.com>

  1. … 15 more files in changeset.
Fix broken links in Working With Files chapter (#6548)

Add missing closing square bracket to two links.

Signed-off-by: thc202 <thc202@gmail.com>

include Kotlin DSL sample for chapter working_with_files (archivesChangedBaseName example)

Issue #6442

Signed-off-by: jnizet <jb@ninja-squad.com>

  1. … 10 more files in changeset.
include Kotlin DSL sample for chapter working_with_files (archiveNaming example)

Issue #6442

Signed-off-by: jnizet <jb@ninja-squad.com>

  1. … 11 more files in changeset.
include Kotlin DSL sample for chapter working_with_files (sync example)

Issue #6442

Signed-off-by: jnizet <jb@ninja-squad.com>

  1. … 7 more files in changeset.
include Kotlin DSL sample for chapter working_with_files (inputFiles example)

Issue #6442

Signed-off-by: jnizet <jb@ninja-squad.com>

  1. … 7 more files in changeset.
include Kotlin DSL sample for chapter working_with_files (fileTrees example)

Issue #6442

Signed-off-by: jnizet <jb@ninja-squad.com>

  1. … 7 more files in changeset.
include Kotlin DSL sample for chapter working_with_files (fileCollections example)

Issue #6442

Signed-off-by: jnizet <jb@ninja-squad.com>

  1. … 9 more files in changeset.
include Kotlin DSL sample for chapter working_with_files (file example)

Issue #6442

Signed-off-by: jnizet <jb@ninja-squad.com>

  1. … 7 more files in changeset.
include Kotlin DSL sample for chapter working_with_files (sampleJavaProject example)

Issue #6442

Signed-off-by: jnizet <jb@ninja-squad.com>

  1. … 25 more files in changeset.
include Kotlin DSL sample for chapter working_with_files (misc example)

Issue #6442

Signed-off-by: jnizet <jb@ninja-squad.com>

  1. … 28 more files in changeset.
include Kotlin DSL sample for chapter working_with_files (archivesWithJavaPlugin example)

Issue #6442

Signed-off-by: jnizet <jb@ninja-squad.com>

  1. … 25 more files in changeset.
include Kotlin DSL sample for chapter working_with_files (archives example)

Issue #6442

Signed-off-by: jnizet <jb@ninja-squad.com>

  1. … 10 more files in changeset.
include Kotlin DSL sample for chapter working_with_files (archivesWithBasePlugin example)

Issue #6442

Signed-off-by: jnizet <jb@ninja-squad.com>

  1. … 7 more files in changeset.
include Kotlin DSL sample for chapter working_with_files (copy example)

Issue #6442

Signed-off-by: jnizet <jb@ninja-squad.com>

  1. … 40 more files in changeset.
Add test precondition for tests that rely on working dir modification

  1. … 6 more files in changeset.
Add test precondition for tests that rely on working dir modification

  1. … 6 more files in changeset.
Make recommendation against `new File(relativePath)` stronger

This doesn't work in a lot of cases and must never be used.

Users need to use `Project.file` instead.

Make recommendation against `new File(relativePath)` stronger

This doesn't work in a lot of cases and must never be used.

Users need to use `Project.file` instead.

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](https://github.com/gradle/dotorg-docs/tree/master/docs-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.
Rename user manual asciidoc files to snake_case

This makes the file names match the output HTML file names,

allowing for us to convert the user manual to asciidoc only.

See also #5837

    • -0
    • +851
    ./working_with_files.adoc
  1. … 170 more files in changeset.