Giter Club home page Giter Club logo

coccinelleforrust_personal_mirror's Introduction

Not my project, ref: https://gitlab.inria.fr/coccinelle/coccinelleforrust



README

Introduction

Coccinelle is a tool for automatic program matching and transformation that was originally developed for making large scale changes to the Linux kernel source code (ie, C code). Matches and transformations are driven by user-specific transformation rules having the form of abstracted patches, referred to as semantic patches. As the Linux kernel, and systems software more generally, is starting to adopt Rust, we are developing Coccinelle for Rust, to make the power of Coccinelle available to Rust codebases.

Install

Build from source

git clone https://gitlab.inria.fr/coccinelle/coccinelleforrust && cd coccinelleforrust

cargo build --release

cp target/release/cfr ~/.local/bin/

This will build the cfr binary and make it available for the user.

Usage

cfr [OPTIONS] -c <COCCIFILE> <TARGETPATH>

COCCIFILE - Is the Semantic Patch file

TARGETPATH - Can be a file or directory

Example - cfr -c patch.cocci myproject/src/

Options

-c, --coccifile <COCCIFILE>
        Path of Semantic Patch File path
-o, --output <OUTPUT>
        Path of transformed file path
-r, --rustfmt-config <RUSTFMT_CONFIG>
        rustfmt config file path
-i, --ignore <IGNORE>
        [default: ]
-d, --debug
        
    --apply
        
    --suppress-diff
        
    --suppress-formatting
        
    --no-parallel
        
    --worth-trying <WORTH_TRYING>
        strategy for identifying files that may be matched by the semantic patch 
        [default: cocci-grep] 
        [possible values: no-scanner, grep, git-grep, cocci-grep]
-h, --help
        Print help
-V, --version
        Print version

Joining the mailing list

Email subscribe cfr FirstName LastName to [email protected] to join the cfr mailing list.

Contributing:

Contributions are welcome. Please sign your contributions, according to the following text extracted from Documentation/SubmittingPatches.txt of the Linux kernel:

The sign-off is a simple line at the end of the explanation for the patch, which certifies that you wrote it or otherwise have the right to pass it on as an open-source patch. The rules are pretty simple: if you can certify the below:

    Developer's Certificate of Origin 1.1

    By making a contribution to this project, I certify that:

    (a) The contribution was created in whole or in part by me and I
        have the right to submit it under the open source license
        indicated in the file; or

    (b) The contribution is based upon previous work that, to the best
        of my knowledge, is covered under an appropriate open source
        license and I have the right under that license to submit that
        work with modifications, whether created in whole or in part
        by me, under the same open source license (unless I am
        permitted to submit under a different license), as indicated
        in the file; or

    (c) The contribution was provided directly to me by some other
        person who certified (a), (b) or (c) and I have not modified
        it.

(d) I understand and agree that this project and the contribution
    are public and that a record of the contribution (including all
    personal information I submit with it, including my sign-off) is
    maintained indefinitely and may be redistributed consistent with
    this project or the open source license(s) involved.

then you just add a line saying

Signed-off-by: Random J Developer <[email protected]>

using your real name (sorry, no pseudonyms or anonymous contributions.)

coccinelleforrust_personal_mirror's People

Contributors

tathagataroy1278 avatar julialawall avatar tin-z avatar lymkwi avatar thierry-martinez avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.