chromium/src
0
Fork 0
Code Activity

updater: add dev guidelines for converting base::FilePath to strings

Browse Source 
Bug: 397561234
Change-Id: I505b88ee9f45a88bb5a9a7d840e0e94fc8d4812a
Reviewed-on: https://chromium-review.googlesource.com/c/chromium/src/+/6321731
Commit-Queue: Sorin Jianu <sorin@chromium.org>
Reviewed-by: Sorin Jianu <sorin@chromium.org>
Auto-Submit: S Ganesh <ganesh@chromium.org>
Cr-Commit-Position: refs/heads/main@{#1427919}
This commit is contained in:
S. Ganesh
2025-03-04 12:47:15 -08:00
committed by Chromium LUCI CQ
parent 6cd3603af2
commit 1d1b6407d9
1 changed files with 13 additions and 0 deletions

13
docs/updater/dev_manual.md

@ -232,6 +232,19 @@ These are the rules to follow when constructing a `FilePath` from a string:
* cross-platform code is expected to use UTF8 literals or UTF8 strings
only.
#### Converting a file path to a string
These are the rules to follow when converting a `FilePath` to a string:
1. Use `base::FilePath::value()` for platform-specific code
* Since `value()` does not do any conversions, it is the safest function
to use for platform-specific code, since the characters can retain their
native format without undergoing any conversions.
2. Use `base::FilePath::AsUTF8Unsafe` for cross-platform code
* `AsUTF8Unsafe` is safe to use for both `Posix` (where it returns the
underlying string unmodified) and `Windows` (where the underlying wide
string is converted using `base::WideToUTF8`).
### Mind the dependencies
To enforce layering, there are enforced rules about what can be included in