llvm-project/llvm/lib/Support/Windows
Brian Gesiak 82de4e6b93 [Support] Add docs for 'openFileFor{Write,Read}'
Summary:
Add documentation for the LLVM Support functions `openFileForWrite` and
`openFileForRead`. The `openFileForRead` parameter `RealPath`, in
particular, I think warranted some explanation.

In addition, make the behavior of the functions more consistent across
platforms. Prior to this patch, Windows would set or not set the result
file descriptor based on the nature of the error, whereas Unix would
consistently set it to `-1` if the open failed. Make Windows
consistently set it to `-1` as well.

Test Plan:
1. `ninja check-llvm`
2. `ninja docs-llvm-html`

Reviewers: zturner, rnk, danielmartin, scanon

Reviewed By: danielmartin, scanon

Subscribers: scanon, danielmartin, llvm-commits

Differential Revision: https://reviews.llvm.org/D46499

llvm-svn: 332075
2018-05-11 01:47:27 +00:00
..
COM.inc
DynamicLibrary.inc Allow clients to specify search order of DynamicLibraries. 2017-07-12 21:22:45 +00:00
Host.inc Update the Windows version of updateTripleOSVersion to account for 2017-07-07 10:08:52 +00:00
Memory.inc [Support] Support NetBSD PaX MPROTECT in sys::Memory. 2017-11-16 23:04:44 +00:00
Mutex.inc Remove more name space pollution from .inc files 2017-03-31 14:26:44 +00:00
Path.inc [Support] Add docs for 'openFileFor{Write,Read}' 2018-05-11 01:47:27 +00:00
Process.inc Remove \brief commands from doxygen comments. 2018-05-01 15:54:18 +00:00
Program.inc Convenience/safety fix for llvm::sys::Execute(And|No)Wait 2017-09-13 17:03:37 +00:00
RWMutex.inc Report fatal error in the case of out of memory 2018-02-20 05:41:26 +00:00
Signals.inc Remove \brief commands from doxygen comments. 2018-05-01 15:54:18 +00:00
ThreadLocal.inc Remove more name space pollution from .inc files 2017-03-31 14:26:44 +00:00
Threading.inc Fix C2712 build error on Windows 2017-03-07 20:09:46 +00:00
Watchdog.inc
WindowsSupport.h Rename sys::Process::GetArgumentVector -> sys::windows::GetCommandLineArguments 2018-04-17 21:09:16 +00:00
explicit_symbols.inc