Skip to content

Commit

Permalink
Improve documentation for OutputService#createSymlinkTree.
Browse files Browse the repository at this point in the history
Document that the map may contain null values to represent empty files and link to the relevant python logic.

Note that the special handling for `__init__.py` files could be cleaned up if #10076 is fixed.

PiperOrigin-RevId: 644090954
Change-Id: I8b402059125a52e27615ddbd559c5aa538c2d6ff
  • Loading branch information
justinhorvitz authored and copybara-github committed Jun 17, 2024
1 parent 8d62528 commit fc570e1
Showing 1 changed file with 7 additions and 6 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -151,16 +151,17 @@ void finalizeAction(Action action, OutputMetadataStore outputMetadataStore)
@Nullable
BatchStat getBatchStatter();

/**
* @return true iff createSymlinkTree() is available.
*/
/** Returns true iff {@link #createSymlinkTree} is available. */
boolean canCreateSymlinkTree();

/**
* Creates the symlink tree
* Creates a symlink tree.
*
* @param symlinks the symlinks to create
* @param symlinkTreeRoot the symlink tree root, relative to the execRoot
* @param symlinks map from {@code symlinkTreeRoot}-relative path to symlink target; may contain
* null values to represent an empty file instead of a symlink (can happen with {@code
* __init__.py} files, see {@link
* com.google.devtools.build.lib.rules.python.PythonUtils.GetInitPyFiles})
* @param symlinkTreeRoot the symlink tree root, relative to the exec root
* @throws ExecException on failure
*/
void createSymlinkTree(Map<PathFragment, PathFragment> symlinks, PathFragment symlinkTreeRoot)
Expand Down

0 comments on commit fc570e1

Please sign in to comment.