[PATCH] D52545: [docs] Update PostingList string representation format
This revision was automatically updated to reflect the committed changes.
Closed by commit rL343116: [docs] Update PostingList string representation
format (authored by omtcyfz, committed by ).
Herald added a subscriber: llvm-commits.
Changed prior to commit:
https://reviews.llvm.org/D52545?vs=167138=167141#toc
Repository:
rL LLVM
https://reviews.llvm.org/D52545
Files:
clang-tools-extra/trunk/clangd/index/dex/Iterator.h
Index: clang-tools-extra/trunk/clangd/index/dex/Iterator.h
===
--- clang-tools-extra/trunk/clangd/index/dex/Iterator.h
+++ clang-tools-extra/trunk/clangd/index/dex/Iterator.h
@@ -94,9 +94,8 @@
///
/// Where Type is the iterator type representation: "&" for And, "|" for Or,
/// ChildN is N-th iterator child. Raw iterators over PostingList are
- /// represented as "[ID1, ID2, ..., {IDN}, ... END]" where IDN is N-th
- /// PostingList entry and the element which is pointed to by the PostingList
- /// iterator is enclosed in {} braces.
+ /// represented as "[... CurID ...]" where CurID is the current PostingList
+ /// entry being inspected.
friend llvm::raw_ostream <<(llvm::raw_ostream ,
const Iterator ) {
return Iterator.dump(OS);
Index: clang-tools-extra/trunk/clangd/index/dex/Iterator.h
===
--- clang-tools-extra/trunk/clangd/index/dex/Iterator.h
+++ clang-tools-extra/trunk/clangd/index/dex/Iterator.h
@@ -94,9 +94,8 @@
///
/// Where Type is the iterator type representation: "&" for And, "|" for Or,
/// ChildN is N-th iterator child. Raw iterators over PostingList are
- /// represented as "[ID1, ID2, ..., {IDN}, ... END]" where IDN is N-th
- /// PostingList entry and the element which is pointed to by the PostingList
- /// iterator is enclosed in {} braces.
+ /// represented as "[... CurID ...]" where CurID is the current PostingList
+ /// entry being inspected.
friend llvm::raw_ostream <<(llvm::raw_ostream ,
const Iterator ) {
return Iterator.dump(OS);
___
cfe-commits mailing list
cfe-commits@lists.llvm.org
http://lists.llvm.org/cgi-bin/mailman/listinfo/cfe-commits
[PATCH] D52545: [docs] Update PostingList string representation format
kbobyrev updated this revision to Diff 167138.
kbobyrev added a comment.
Simplify the documentation format.
https://reviews.llvm.org/D52545
Files:
clang-tools-extra/clangd/index/dex/Iterator.h
Index: clang-tools-extra/clangd/index/dex/Iterator.h
===
--- clang-tools-extra/clangd/index/dex/Iterator.h
+++ clang-tools-extra/clangd/index/dex/Iterator.h
@@ -94,9 +94,8 @@
///
/// Where Type is the iterator type representation: "&" for And, "|" for Or,
/// ChildN is N-th iterator child. Raw iterators over PostingList are
- /// represented as "[ID1, ID2, ..., {IDN}, ... END]" where IDN is N-th
- /// PostingList entry and the element which is pointed to by the PostingList
- /// iterator is enclosed in {} braces.
+ /// represented as "[... CurID ...]" where CurID is the current PostingList
+ /// entry being inspected.
friend llvm::raw_ostream <<(llvm::raw_ostream ,
const Iterator ) {
return Iterator.dump(OS);
Index: clang-tools-extra/clangd/index/dex/Iterator.h
===
--- clang-tools-extra/clangd/index/dex/Iterator.h
+++ clang-tools-extra/clangd/index/dex/Iterator.h
@@ -94,9 +94,8 @@
///
/// Where Type is the iterator type representation: "&" for And, "|" for Or,
/// ChildN is N-th iterator child. Raw iterators over PostingList are
- /// represented as "[ID1, ID2, ..., {IDN}, ... END]" where IDN is N-th
- /// PostingList entry and the element which is pointed to by the PostingList
- /// iterator is enclosed in {} braces.
+ /// represented as "[... CurID ...]" where CurID is the current PostingList
+ /// entry being inspected.
friend llvm::raw_ostream <<(llvm::raw_ostream ,
const Iterator ) {
return Iterator.dump(OS);
___
cfe-commits mailing list
cfe-commits@lists.llvm.org
http://lists.llvm.org/cgi-bin/mailman/listinfo/cfe-commits
[PATCH] D52545: [docs] Update PostingList string representation format
ioeric added inline comments.
Comment at: clang-tools-extra/clangd/index/dex/Iterator.h:97
/// ChildN is N-th iterator child. Raw iterators over PostingList are
- /// represented as "[ID1, ID2, ..., {IDN}, ... END]" where IDN is N-th
- /// PostingList entry and the element which is pointed to by the PostingList
- /// iterator is enclosed in {} braces.
+ /// represented as "[(...)? (IDN | END) (...)?]" where IDN is N-th
+ /// PostingList entry.
nit: `[(...)? (IDN | END) (...)?]` is accurate but can be really confusing... I
think it's okay to be a bit inaccurate with just `[ ... CurID ... ]`.
https://reviews.llvm.org/D52545
___
cfe-commits mailing list
cfe-commits@lists.llvm.org
http://lists.llvm.org/cgi-bin/mailman/listinfo/cfe-commits
[PATCH] D52545: [docs] Update PostingList string representation format
kbobyrev created this revision.
kbobyrev added reviewers: ioeric, sammccall.
kbobyrev added a project: clang-tools-extra.
Herald added subscribers: kadircet, arphaman, jkorous.
Because `PostingList` objects are compressed, it is now impossible to see
elements other than the current one and the documentation doesn't match
implementation anymore.
https://reviews.llvm.org/D52545
Files:
clang-tools-extra/clangd/index/dex/Iterator.h
Index: clang-tools-extra/clangd/index/dex/Iterator.h
===
--- clang-tools-extra/clangd/index/dex/Iterator.h
+++ clang-tools-extra/clangd/index/dex/Iterator.h
@@ -94,9 +94,8 @@
///
/// Where Type is the iterator type representation: "&" for And, "|" for Or,
/// ChildN is N-th iterator child. Raw iterators over PostingList are
- /// represented as "[ID1, ID2, ..., {IDN}, ... END]" where IDN is N-th
- /// PostingList entry and the element which is pointed to by the PostingList
- /// iterator is enclosed in {} braces.
+ /// represented as "[(...)? (IDN | END) (...)?]" where IDN is N-th
+ /// PostingList entry.
friend llvm::raw_ostream <<(llvm::raw_ostream ,
const Iterator ) {
return Iterator.dump(OS);
Index: clang-tools-extra/clangd/index/dex/Iterator.h
===
--- clang-tools-extra/clangd/index/dex/Iterator.h
+++ clang-tools-extra/clangd/index/dex/Iterator.h
@@ -94,9 +94,8 @@
///
/// Where Type is the iterator type representation: "&" for And, "|" for Or,
/// ChildN is N-th iterator child. Raw iterators over PostingList are
- /// represented as "[ID1, ID2, ..., {IDN}, ... END]" where IDN is N-th
- /// PostingList entry and the element which is pointed to by the PostingList
- /// iterator is enclosed in {} braces.
+ /// represented as "[(...)? (IDN | END) (...)?]" where IDN is N-th
+ /// PostingList entry.
friend llvm::raw_ostream <<(llvm::raw_ostream ,
const Iterator ) {
return Iterator.dump(OS);
___
cfe-commits mailing list
cfe-commits@lists.llvm.org
http://lists.llvm.org/cgi-bin/mailman/listinfo/cfe-commits
