LowerBitSets.cpp: Prune incorrect \param(s). [-Wdocumentation]
[oota-llvm.git] / lib / Support / SystemUtils.cpp
1 //===- SystemUtils.cpp - Utilities for low-level system tasks -------------===//
2 //
3 //                     The LLVM Compiler Infrastructure
4 //
5 // This file is distributed under the University of Illinois Open Source
6 // License. See LICENSE.TXT for details.
7 //
8 //===----------------------------------------------------------------------===//
9 //
10 // This file contains functions used to do a variety of low-level, often
11 // system-specific, tasks.
12 //
13 //===----------------------------------------------------------------------===//
14
15 #include "llvm/Support/SystemUtils.h"
16 #include "llvm/Support/Process.h"
17 #include "llvm/Support/Program.h"
18 #include "llvm/Support/raw_ostream.h"
19 using namespace llvm;
20
21 bool llvm::CheckBitcodeOutputToConsole(raw_ostream &stream_to_check,
22                                        bool print_warning) {
23   if (stream_to_check.is_displayed()) {
24     if (print_warning) {
25       errs() << "WARNING: You're attempting to print out a bitcode file.\n"
26                 "This is inadvisable as it may cause display problems. If\n"
27                 "you REALLY want to taste LLVM bitcode first-hand, you\n"
28                 "can force output with the `-f' option.\n\n";
29     }
30     return true;
31   }
32   return false;
33 }