Details
-
Bug
-
Resolution: Done
-
P2: Important
-
0.3
-
None
Description
This is a huge problem in my opinion so I'm marking it as a bug.
We should be very consistent with our use of terminology pertaining to file names and file paths, as improper naming of properties leads to confusion and accidental misuse of the toolset.
We should standardize our usage of the names as follows:
- absoluteFilePath: an absolute path to a file, example "/Users/jake/cube.qbs"
- filePath: an absolute or relative path to a file, example "/Users/jake/cube.qbs" or "../fake/sphere.qbs"
- absolutePath: an absolute directory path, example "/Users/jake"
- path: an absolute or relative directory path, example "/Users/jake" or "../fake"
- fileName: a file name only, without a path, example: "sphere.qbs"
- absoluteFileName: this means nothing. You're fired.
Proper usage of these terms will make it significantly easier for developers to know what type of path they're being given so that it may be handled correctly.
Attachments
Issue Links
- relates to
-
QBS-487 Rule, Transformer and Artifact documentation should describe input and output variables in more detail
- Closed
For Gerrit Dashboard: QBS-258 | ||||||
---|---|---|---|---|---|---|
# | Subject | Branch | Project | Status | CR | V |
79193,2 | rename fileName property in prepare scripts to filePath | master | qbs/qbs | Status: MERGED | +2 | 0 |
79194,2 | use filePath instead of fileName where applicable | master | qbs/qbs | Status: MERGED | +2 | 0 |