This is an archive of the discontinued LLVM Phabricator instance.

[LLDB][Docs] Move best-practices.txt contain to resources/test.rst
ClosedPublic

Authored by xgupta on Aug 27 2021, 2:45 AM.

Details

Summary

This file contain some old reference to files those are now either renamed or replaced.
Also this .txt file didn't generate to html during the sphnix documentation build so I send its contents to resources/test.rst file.

Signed-off-by: Shivam Gupta <shivam98.tkg@gmail.com>

Diff Detail

Event Timeline

xgupta created this revision.Aug 27 2021, 2:45 AM
xgupta published this revision for review.Aug 27 2021, 8:02 AM
xgupta added reviewers: teemperor, mgorny, JDevlieghere.
Herald added a project: Restricted Project. · View Herald TranscriptAug 27 2021, 8:02 AM

I later realize that we already have https://lldb.llvm.org/resources/test.html which contains some similar instructions to write testcases. So not sure we want to have this document.

mgorny requested changes to this revision.Aug 28 2021, 3:34 AM
mgorny added inline comments.
lldb/docs/testsuite/best-practices.rst
20

…seems to be a common pattern in LLVM.

(and similarly for other instances of ::)

This revision now requires changes to proceed.Aug 28 2021, 3:34 AM
xgupta updated this revision to Diff 369252.Aug 28 2021, 4:27 AM

Fix .. code-block::

lldb/docs/testsuite/best-practices.rst
20

Thanks, I missed that.

mgorny accepted this revision.Aug 28 2021, 4:33 AM

Thanks for doing this. Presuming you've verified that it renders correctly, LGTM.

This revision is now accepted and ready to land.Aug 28 2021, 4:33 AM
xgupta updated this revision to Diff 369254.Aug 28 2021, 4:50 AM

add best-practices entry to index.rst

I can confirm that it renders correctly, please commit it at your convenience. Thanks.

teemperor added inline comments.Aug 28 2021, 6:00 AM
lldb/docs/testsuite/best-practices.rst
54

This section here seems very outdated, can we just delete it?

xgupta updated this revision to Diff 369328.Aug 29 2021, 10:21 AM

Remove an outdated paragraph

lldb/docs/testsuite/best-practices.rst
54

sure

JDevlieghere requested changes to this revision.Aug 29 2021, 9:55 PM

I'm not convinced this warrants a whole new section. Especially since this is focussed on lldb developers rather than end users. Could we move this under the resources/test page?

This revision now requires changes to proceed.Aug 29 2021, 9:55 PM
xgupta updated this revision to Diff 369374.Aug 29 2021, 10:35 PM

Move testsuite/best-practice comtain to resources/test.

I'm not convinced this warrants a whole new section. Especially since this is focussed on lldb developers rather than end users. Could we move this under the resources/test page?

Agree. I also think so.

xgupta updated this revision to Diff 369375.Aug 29 2021, 10:39 PM

remove best-practice.rst

xgupta updated this revision to Diff 369376.Aug 29 2021, 10:45 PM

restore a blank line

xgupta retitled this revision from [LLDB][Docs] Renew best-practices.txt to [LLDB][Docs] Move best-practices.txt contain to resources/test.rst.Aug 29 2021, 10:47 PM
xgupta edited the summary of this revision. (Show Details)
JDevlieghere accepted this revision.Aug 29 2021, 10:50 PM

Thanks for the quick turnaround! This LGTM

This revision is now accepted and ready to land.Aug 29 2021, 10:50 PM

I will ask for commit access and commit it soon.

teemperor accepted this revision.Aug 30 2021, 3:18 AM

Thanks, LGTM!

lldb/docs/testsuite/best-practices.rst