Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Amend description of FilenameUtils#getFullPathNoEndSeparator(String) to reflect correct named user result with trailing slash #553

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Amend description of FilenameUtils#getFullPathNoEndSeparator(String) to reflect correct named user result with trailing slash #553

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion src/main/java/org/apache/commons/io/FilenameUtils.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -669,7 +669,7 @@ public static String getFullPath(final String fileName) {
* ~ --> ~
* ~/ --> ~
* ~user --> ~user
* ~user/ --> ~user
* ~user/ --> ~user/
Copy link
Member

@garydgregory garydgregory Jan 4, 2024 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This causes the Javadoc to contradict itself with the above's excluding the final directory separator.
The question is whether Windows's "C:\" unchanged output is a special case or a bug.
CC: @elharo

Copy link
Contributor

@elharo elharo Jan 4, 2024 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The existing javadoc and API is very unclear. I do not understand "Gets the full path from a full fileName, which is the prefix + path, and also excluding the final directory separator."

The argument is not a filename. There is no such thing as a "full path" in normal parlance. Bug filed. https://issues.apache.org/jira/browse/IO-836

I also agree that if this method turns ~user/ into ~user/ that's a bug. It should produce ~user.

C:\ should also (80% certainty) turn into C:, not C:\

I further expect there are additional bugs in this method involving Unix shell conventions and platform dependencies, but I'd have to dig into the rest of the class to understand exactly what those are.

What a tasty can of worms you've opened. :-)

* </pre>
* <p>
* The output will be the same irrespective of the machine that the code is running on.
Expand Down