correctcomputation / checkedc-clang

This is the primary development repository for 3C, a tool for automatically converting legacy C code to the Checked C extension of C, which aims to enforce spatial memory safety. This repository is a fork of Checked C's.
14 stars 5 forks source link

repository reorg #286

Closed mwhicks1 closed 3 years ago

mwhicks1 commented 4 years ago

Here's a bunch of non-code work to do on this repository:

Renames:

Documentation:

Misc:

clang/docs/checkedc/3C.md can talk at a high level of about the 3C tool and what it does and point out that there is the possibility of multiple front-ends for it, so most of the code is here, in a library. This file (or another MD in the same directory) can contain a basic overview of the code, running the regression tests, and some development guidelines.

The clang/tools/3c README can talk about how to run the tool, e.g., something about the command-line options, perhaps.

Some of the information we want to put in the new readmes may be available in our existing Google Docs, though perhaps not all.

mattmccutchen-cci commented 4 years ago

Plan to get rid of the tools/checked-c-convert directory. To do so, add a README that says this directory is out of date and scheduled for removal. (We will remove it when Microsoft is OK with that.)

The only thing in tools/checked-c-convert is a test case that looks like an old duplicate of this one. Another old duplicate of the test is the only thing in test/CheckedCRewriter. Can I just delete both old directories now?

mwhicks1 commented 4 years ago

Yes, let's do it.

mattmccutchen-cci commented 4 years ago

I notice we currently have a readme at clang/docs/checkedc/CheckedCConvert.md (planned to be renamed to clang/docs/checkedc/3C.md). @mwhicks1 Is that a better location for the information we had previously planned to put in clang/lib/3C?

mwhicks1 commented 4 years ago

I'm not sure. We should follow the conventions for tools that build on clang I would think. Is that where they put their docs too? @Machiry do you have an opinion?

Machiry commented 4 years ago

@mattmccutchen-cci is right. Lets put the documentation under clang/docs/checkedc/3C.md

mattmccutchen-cci commented 3 years ago

The last items were done in #323. I'll file separate issues as needed for improvements after the Microsoft PR.