Merge pull request #2 from hcindyl:add-bazelrc PiperOrigin-RevId: 525836509 Change-Id: Ibe1a46715a7d3bf6a7d7c8ec8a7654737ff57752
diff --git a/CODE_OF_CONDUCT.md b/CODE_OF_CONDUCT.md index fb086f1..8410ba3 100644 --- a/CODE_OF_CONDUCT.md +++ b/CODE_OF_CONDUCT.md
@@ -71,11 +71,11 @@ Reports should be directed to *[Tor Jeremiassen](torerik@google.com)*, the Project Steward(s) for *[MPACT-Sim](https://mpact.googlesource.com)*. It is the -Project Steward’s duty to receive and address reported violations of the code -of conduct. They will then work with a committee consisting of representatives -from the Open Source Programs Office and the Google Open Source Strategy team. -If for any reason you are uncomfortable reaching out to the Project Steward, -please email opensource@google.com. +Project Steward’s duty to receive and address reported violations of the code of +conduct. They will then work with a committee consisting of representatives from +the Open Source Programs Office and the Google Open Source Strategy team. If for +any reason you are uncomfortable reaching out to the Project Steward, please +email opensource@google.com. We will investigate every complaint, but you may not receive a direct response. We will use our discretion in determining when and how to follow up on reported @@ -93,4 +93,4 @@ https://www.contributor-covenant.org/version/1/4/code-of-conduct.html Note: A version of this file is also available in the -[New Project repo](https://github.com/google/new-project/blob/master/docs/code-of-conduct.md). \ No newline at end of file +[New Project repo](https://github.com/google/new-project/blob/master/docs/code-of-conduct.md).
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 47634bc..37ae0a4 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md
@@ -20,8 +20,8 @@ ### Review our Community Guidelines -This project follows [Google's Open Source Community -Guidelines](https://opensource.google/conduct/). +This project follows +[Google's Open Source Community Guidelines](https://opensource.google/conduct/). ## Contribution process @@ -30,4 +30,4 @@ All submissions, including submissions by project members, require review. We use GitHub pull requests for this purpose. Consult [GitHub Help](https://help.github.com/articles/about-pull-requests/) for more -information on using pull requests. \ No newline at end of file +information on using pull requests.
diff --git a/README.md b/README.md index fa7e6bf..c3f414d 100644 --- a/README.md +++ b/README.md
@@ -3,23 +3,22 @@ MPACT-Sim is a toolkit that reduces the effort to create instruction set simulators, and make the resulting simulators easy to change and extend. -This repository contains the C++ code for MPACT-Sim, tools and -library support for making it simple to create easily retargetable -simulators for a wide range of instruction set architectures. +This repository contains the C++ code for MPACT-Sim, tools and library support +for making it simple to create easily retargetable simulators for a wide range +of instruction set architectures. -The toolkit consists of three major components. The first is the isa and -binary decoder generators, that take in descriptors of the isa and the binary -encoding of instructions and produce C++ code used in writing a decoder. The -second is the generic classes that implement the instruction objects, -registers, and other simulated state objects, and the code necessary to -manipulate them, as well as supporting writing the semantics of the -instructions. Lastly, there are utility classes that make it easier to put -together a finished simulator, including memory classes and an ELF -loader. +The toolkit consists of three major components. The first is the isa and binary +decoder generators, that take in descriptors of the isa and the binary encoding +of instructions and produce C++ code used in writing a decoder. The second is +the generic classes that implement the instruction objects, registers, and other +simulated state objects, and the code necessary to manipulate them, as well as +supporting writing the semantics of the instructions. Lastly, there are utility +classes that make it easier to put together a finished simulator, including +memory classes and an ELF loader. ## Building -MPACT-Sim utilizes the [bazel](https://bazel.build/) build system. +MPACT-Sim utilizes the [bazel](https://bazel.build/) build system. ## Directory Listing @@ -29,9 +28,9 @@ instructions and instruction encodings of an ISA, and generate C++ code for the instruction decoder for an MPACT-Sim simulator. - The tools are built automatically and the process is largly invisible - when using bazel with the appropriate build targets - see the tests - in mpact/sim/decoder/test for examples. + The tools are built automatically and the process is largly invisible when + using bazel with the appropriate build targets - see the tests in + mpact/sim/decoder/test for examples. * mpact/sim/generic <br /> This directory contains alll the generic classes provided for use
diff --git a/SECURITY.md b/SECURITY.md index 8f1236c..4648e5e 100644 --- a/SECURITY.md +++ b/SECURITY.md
@@ -1,4 +1,4 @@ To report a security issue, please use [https://g.co/vulnz](https://g.co/vulnz). We use g.co/vulnz for our intake, and do coordination and disclosure here on GitHub (including using GitHub Security Advisory). The Google Security Team will -respond within 5 working days of your report on g.co/vulnz. \ No newline at end of file +respond within 5 working days of your report on g.co/vulnz.
diff --git a/build.sh b/build.sh index 9128700..0fefb4a 100755 --- a/build.sh +++ b/build.sh
@@ -1,4 +1,17 @@ #!/bin/bash +# Copyright 2023 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# https://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. # Fail on any error set -e