File _service:obs_scm:README.en.md of Package uncrustify_vendor

# uncrustify_vendor

#### Description
A source code beautifier for C, C++, C#, ObjectiveC, D, Java, Pawn and VALA
CMake shim over the uncrustify library: https://github.com/uncrustify/uncrustify

#### Software Architecture
Software architecture description

https://github.com/uncrustify/uncrustify

input:
```
├── 45b836cff040594994d364ad6fd3f04adc890a26.tar.gz
├── CMakeLists.txt
├── install-patch.diff
├── LICENSE
├── package.xml
└── README.md
```

#### Installation

1.  Download RPM

aarch64:

```
wget https://117.78.1.88/build/home:Chenjy3_22.03/openEuler_22.03_LTS_standard_aarch64/aarch64/uncrustify_vendor/ros2-foxy-ros2-uncrustify_vendor-1.4.0-2.oe2203.aarch64.rpm
```

x86_64:

```
wget https://117.78.1.88/build/home:Chenjy3_22.03/openEuler_22.03_LTS_standard_x86_64/x86_64/uncrustify_vendor/ros2-foxy-uncrustify_vendor-1.4.0-2.oe2203.x86_64.rpm
```

2.  Install RPM

aarch64:

```
sudo rpm -ivh --nodeps --force ros2-foxy-ros2-uncrustify_vendor-1.4.0-2.oe2203.aarch64.rpm
```

x86_64:

```
sudo rpm -ivh --nodeps --force ros2-foxy-ros2-uncrustify_vendor-1.4.0-2.oe2203.x86_64.rpm
```

#### Instructions

Dependence installation:

```
sh /opt/ros/foxy/install_dependence.sh
```

Exit the following output file under the /opt/ros/foxy/ directory,Prove that the software installation is successful.

output:

```
├── bin
│   └── uncrustify
└── share
├── ament_index
├── colcon-core
└── uncrustify_vendor
```
Here are ways to run it:
```
$ uncrustify -c mystyle.cfg -f somefile.c -o somefile.c.unc
$ uncrustify -c mystyle.cfg -f somefile.c > somefile.c.unc
$ uncrustify -c mystyle.cfg somefile.c
$ uncrustify -c mystyle.cfg --no-backup somefile.c
$ uncrustify -c mystyle.cfg *.c
$ uncrustify -c mystyle.cfg --no-backup *.c
```
The `-c` flag selects the configuration file.
The `-f` flag specifies the input file.
The `-o` flag specifies the output file.
If flag `-f` is used without flag `-o` the output will be send to `stdout`.
Alternatively multiple or single files that should be processed can be
specified at the command end without flags.
If the flag `--no-backup` is missing, every file saved with the initial
name and an additional suffix (can be changed with --suffix).
For more options descriptions call:
```bash
$ uncrustify -h
```
Uncrustify usually reads configuration files that are passed via the `-c`
flag. If the flag is not provided Uncrustify will try to find a
configuration file via the `UNCRUSTIFY_CONFIG` environment variable or a
file with the name `uncrustify` or `.uncrustify` in your home folder.
To get a list of:
- all available options use:
```bash
uncrustify --show-config
```
- all available options in a usable configuration file format use:
```bash
uncrustify --update-config
```
or
```bash
uncrustify --update-config-with-doc
```
As the names suggest both options can produce output that adds newly
introduced options to your old configuration file. For this your old
configuration file has to be passed via the `-c` flag:
```bash
uncrustify --update-config-with-doc -c path/to/your.cfg
```

#### Contribution

1.  Fork the repository
2.  Create Feat_xxx branch
3.  Commit your code
4.  Create Pull Request

#### Gitee Feature

1.  You can use Readme\_XXX.md to support different languages, such as Readme\_en.md, Readme\_zh.md
2.  Gitee blog [blog.gitee.com](https://blog.gitee.com)
3.  Explore open source project [https://gitee.com/explore](https://gitee.com/explore)
4.  The most valuable open source project [GVP](https://gitee.com/gvp)
5.  The manual of Gitee [https://gitee.com/help](https://gitee.com/help)
6.  The most popular members  [https://gitee.com/gitee-stars/](https://gitee.com/gitee-stars/)