This is an archive of the discontinued LLVM Phabricator instance.

[docs] Refine the description in Set-Like and Map-Like container options.
ClosedPublic

Authored by HsiangKai on Jan 21 2022, 12:24 AM.

Details

Summary

In "Other Set-Like Container Options":

  • Drops the references to C++ TR1 and SGI and hash_set.
  • Drops the worry about portability (this was a problem with hash_set, but std::unordered_set has worked portably since LLVM started depending on C++11).

It is similar in "Other Map-Like Container Options" section.

Diff Detail

Event Timeline

HsiangKai requested review of this revision.Jan 21 2022, 12:24 AM
HsiangKai created this revision.
Herald added a project: Restricted Project. · View Herald TranscriptJan 21 2022, 12:24 AM

There is no container named hash_set or hash_maa in C++ STL. We should
add double quotes around the word just like previous sentence.

Not sure repeating the double-quotes makes sense; the previous sentence references to SGI and C++ TR1, both of which did have these containers. It sounds like you're using quotes because it's not a real thing, but I'm not sure that applies here.

That said, maybe it's a good idea to drop the hash_* references entirely. Not sure they're relevant anymore.

llvm/docs/ProgrammersManual.rst
2200–2204

See the proposed edit, which:

  • Drops the references to C++ TR1 and SGI and hash_set.
  • Drops the worry about portability (this was a problem with hash_set, but std::unordered_set has worked portably since LLVM started depending on C++11).
HsiangKai added inline comments.Jan 23 2022, 11:50 PM
llvm/docs/ProgrammersManual.rst
2200–2204

It looks good. Thanks.
I will modify it according to your suggestions.

Update ProgrammersManual.rst according to @dexonsmith's suggestions.

HsiangKai edited the summary of this revision. (Show Details)Jan 24 2022, 12:16 AM
HsiangKai edited the summary of this revision. (Show Details)
dexonsmith accepted this revision.Jan 24 2022, 6:46 PM

LGTM, thanks!

This revision is now accepted and ready to land.Jan 24 2022, 6:46 PM