[clang][driver] Restore the original help text for `-I`
authorAndrzej Warzynski <andrzej.warzynski@arm.com>
Wed, 6 Jan 2021 12:49:26 +0000 (12:49 +0000)
committerAndrzej Warzynski <andrzej.warzynski@arm.com>
Wed, 13 Jan 2021 09:19:50 +0000 (09:19 +0000)
commitcbea6737d5130724c7c8cf8ee4ccf1c3dd099450
treeeeab7a120d02c0d814e48ae542a690dfedf87564
parent6d3098e7ff968ad7d3033d7751af05a1fcd2ed9b
[clang][driver] Restore the original help text for `-I`

The help text for `-I` was recently expanded in [1]. The expanded
version focuses on explaining the semantics of `-I` in Clang. We are now
in the process of adding support for `-I` in Flang and this new
description is incompatible with the semantics of `-I` in Flang. This
was brought up in this review:
  * https://reviews.llvm.org/D93453

This patch reverts the original change in Options.td. This way the help
text for `-I` remains generic enough so that it applies to both Clang
and Flang.

The expanded description of `-I` from [1] is moved to the
`DocBrief` field for `-I`. This field is prioritised over the help text
when generating ClangCommandLineReference.rst, so the user facing
documentation for Clang retains the expanded description:
  * https://clang.llvm.org/docs/ClangCommandLineReference.html
`DocBrief` fields are currently not used in Flang.

As requested in the reviews, the help text and the expanded description
are slightly refined.

[1] Commit: 8dd4e3ceb804a58bcf25e6856fc6fde5e1995a66

Differential Revision: https://reviews.llvm.org/D94169
clang/docs/ClangCommandLineReference.rst
clang/include/clang/Driver/Options.td