Skip to content

Commit 661f8fb

Browse files
committed
2 parents 5ce70a0 + df9af17 commit 661f8fb

12 files changed

+443
-74
lines changed

Gemfile

-4
This file was deleted.

Gemfile.lock

-12
This file was deleted.

README.md

-11
Original file line numberDiff line numberDiff line change
@@ -234,14 +234,3 @@ configuration, you may want to run the included test suite. This is the test sui
234234
projects we've used it on) that we use to make sure that things actually work the way we claim.
235235
The test suite makes use of Ceedling, which uses the Unity Test Framework. It will require a native C compiler.
236236
The example makefile and rakefile both use gcc.
237-
238-
License
239-
=======
240-
241-
*This software is licensed under the MIT License:
242-
Copyright (c) 2007-2021 Mark VanderVoord*
243-
244-
*Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
245-
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.*
246-
247-
*_THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE._*

docs/CException.md

-43
Original file line numberDiff line numberDiff line change
@@ -1,30 +1,25 @@
1-
21
CException
32
==========
43

54
CException is a basic exception framework for C, suitable for use in
65
embedded applications. It provides an exception framework similar in
76
use to C++, but with much less overhead.
87

9-
108
CException uses C standard library functions `setjmp` and `longjmp` to
119
operate. As long as the target system has these two functions defined,
1210
this library should be useable with very little configuration. It
1311
even supports environments where multiple program flows are in use,
1412
such as real-time operating systems.
1513

16-
1714
There are about a gabillion exception frameworks using a similar
1815
setjmp/longjmp method out there... and there will probably be more
1916
in the future. Unfortunately, when we started our last embedded
2017
project, all those that existed either (a) did not support multiple
2118
tasks (therefore multiple stacks) or (b) were way more complex than
2219
we really wanted. CException was born.
2320

24-
2521
*Why use CException?*
2622

27-
2823
0. It's ANSI C, and it beats passing error codes around.
2924
1. You want something simple... CException throws a single id. You can
3025
define those ID's to be whatever you like. You might even choose which
@@ -37,10 +32,8 @@ we really wanted. CException was born.
3732
your only additional overhead is the time it takes you to determine
3833
a unique task id 0 - num_tasks.
3934

40-
4135
For the latest version, go to [ThrowTheSwitch.org](http://throwtheswitch.org)
4236

43-
4437
CONTENTS OF THIS DOCUMENT
4538
=========================
4639

@@ -60,20 +53,15 @@ The code directly following the Try call is "protected", meaning that
6053
if any Throws occur, program control is directly transferred to the
6154
start of the Catch block.
6255

63-
6456
A numerical exception ID is included with Throw, and is made accessible
6557
from the Catch block.
6658

67-
6859
Throws can occur from within function calls (nested as deeply as you
6960
like) or directly from within the function itself.
7061

71-
72-
7362
Limitations
7463
-----------
7564

76-
7765
This library was made to be as fast as possible, and provide basic
7866
exception handling. It is not a full-blown exception library. Because
7967
of this, there are a few limitations that should be observed in order
@@ -154,8 +142,6 @@ to successfully utilize this library:
154142
replacing or wrapping malloc calls or something like that. This
155143
is a light framework, so these options were not desirable.
156144

157-
158-
159145
API
160146
---
161147

@@ -255,7 +241,6 @@ you wanted and just use the defaults provided.
255241
this the emergency fallback plan for when something has
256242
gone terribly wrong.
257243

258-
259244
You may also want to include any header files which will commonly be
260245
needed by the rest of your application where it uses exception handling
261246
here. For example, OS header files or exception codes would be useful.
@@ -279,11 +264,9 @@ where you will need these, but they are here if you need them:
279264
* called immediately before the catch
280265

281266

282-
283267
TESTING
284268
-------
285269

286-
287270
If you want to validate that CException works with your tools or that
288271
it works with your custom configuration, you may want to run the test
289272
suite.
@@ -304,29 +287,3 @@ to compile and run the test application.
304287
* The path to the Unity framework (required to run tests)
305288
(get it at [ThrowTheSwitch.org](http://throwtheswitch.org))
306289

307-
308-
309-
LICENSE
310-
-------
311-
312-
This software is licensed under the MIT License
313-
314-
Copyright (c) 2007-2021 Mark VanderVoord
315-
316-
Permission is hereby granted, free of charge, to any person obtaining a copy
317-
of this software and associated documentation files (the "Software"), to deal
318-
in the Software without restriction, including without limitation the rights
319-
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
320-
copies of the Software, and to permit persons to whom the Software is
321-
furnished to do so, subject to the following conditions:
322-
323-
The above copyright notice and this permission notice shall be included in
324-
all copies or substantial portions of the Software.
325-
326-
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
327-
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
328-
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
329-
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
330-
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
331-
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
332-
THE SOFTWARE.

docs/CODE_OF_CONDUCT.md

+138
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,138 @@
1+
2+
# ThrowTheSwitch.org Code of Conduct
3+
4+
Thank you for participating in a ThrowTheSwitch.org community project! We want
5+
this to continue to be a warm and inviting place for everyone to share ideas
6+
and get help. To accomplish this goal, we've developed this Code of Conduct.
7+
8+
## Our Pledge
9+
10+
We as members, contributors, and leaders pledge to make participation in our
11+
community a harassment-free experience for everyone, regardless of age, body
12+
size, visible or invisible disability, ethnicity, sex characteristics, gender
13+
identity and expression, level of experience, education, socio-economic status,
14+
nationality, personal appearance, race, caste, color, religion, or sexual
15+
identity and orientation.
16+
17+
We pledge to act and interact in ways that contribute to an open, welcoming,
18+
diverse, inclusive, and healthy community.
19+
20+
## Our Standards
21+
22+
Examples of behavior that contributes to a positive environment for our
23+
community include:
24+
25+
* Demonstrating empathy and kindness toward other people
26+
* Being respectful of differing opinions, viewpoints, and experiences
27+
* Giving and gracefully accepting constructive feedback
28+
* Accepting responsibility and apologizing to those affected by our mistakes,
29+
and learning from the experience
30+
* Focusing on what is best not just for us as individuals, but for the overall
31+
community
32+
33+
Examples of unacceptable behavior include:
34+
35+
* The use of sexualized language or imagery, and sexual attention or advances of
36+
any kind
37+
* Trolling, insulting or derogatory comments, and personal or political attacks
38+
* Public or private harassment
39+
* Publishing others' private information, such as a physical or email address,
40+
without their explicit permission
41+
* Other conduct which could reasonably be considered inappropriate in a
42+
professional setting
43+
44+
## Enforcement Responsibilities
45+
46+
Community leaders are responsible for clarifying and enforcing our standards of
47+
acceptable behavior and will take appropriate and fair corrective action in
48+
response to any behavior that they deem inappropriate, threatening, offensive,
49+
or harmful.
50+
51+
Community leaders have the right and responsibility to remove, edit, or reject
52+
comments, commits, code, wiki edits, issues, and other contributions that are
53+
not aligned to this Code of Conduct, and will communicate reasons for moderation
54+
decisions when appropriate.
55+
56+
## Scope
57+
58+
This Code of Conduct applies within all community spaces, and also applies when
59+
an individual is officially representing the community in public spaces.
60+
Examples of representing our community include using an official email address,
61+
posting via an official social media account, or acting as an appointed
62+
representative at an online or offline event.
63+
64+
## Enforcement
65+
66+
Instances of abusive, harassing, or otherwise unacceptable behavior may be
67+
reported to the community leaders responsible for enforcement at
68+
hello@thingamabyte.com.
69+
70+
All complaints will be reviewed and investigated promptly and fairly.
71+
72+
All community leaders are obligated to respect the privacy and security of the
73+
reporter of any incident.
74+
75+
## Enforcement Guidelines
76+
77+
Community leaders will follow these Community Impact Guidelines in determining
78+
the consequences for any action they deem in violation of this Code of Conduct:
79+
80+
### 1. Correction
81+
82+
**Community Impact**: Use of inappropriate language or other behavior deemed
83+
unprofessional or unwelcome in the community.
84+
85+
**Consequence**: A private, written warning from community leaders, providing
86+
clarity around the nature of the violation and an explanation of why the
87+
behavior was inappropriate. A public apology may be requested.
88+
89+
### 2. Warning
90+
91+
**Community Impact**: A violation through a single incident or series of
92+
actions.
93+
94+
**Consequence**: A warning with consequences for continued behavior. No
95+
interaction with the people involved, including unsolicited interaction with
96+
those enforcing the Code of Conduct, for a specified period of time. This
97+
includes avoiding interactions in community spaces as well as external channels
98+
like social media. Violating these terms may lead to a temporary or permanent
99+
ban.
100+
101+
### 3. Temporary Ban
102+
103+
**Community Impact**: A serious violation of community standards, including
104+
sustained inappropriate behavior.
105+
106+
**Consequence**: A temporary ban from any sort of interaction or public
107+
communication with the community for a specified period of time. No public or
108+
private interaction with the people involved, including unsolicited interaction
109+
with those enforcing the Code of Conduct, is allowed during this period.
110+
Violating these terms may lead to a permanent ban.
111+
112+
### 4. Permanent Ban
113+
114+
**Community Impact**: Demonstrating a pattern of violation of community
115+
standards, including sustained inappropriate behavior, harassment of an
116+
individual, or aggression toward or disparagement of classes of individuals.
117+
118+
**Consequence**: A permanent ban from any sort of public interaction within the
119+
community.
120+
121+
## Attribution
122+
123+
This Code of Conduct is adapted from the [Contributor Covenant][homepage],
124+
version 2.1, available at
125+
[https://www.contributor-covenant.org/version/2/1/code_of_conduct.html][v2.1].
126+
127+
Community Impact Guidelines were inspired by
128+
[Mozilla's code of conduct enforcement ladder][Mozilla CoC].
129+
130+
For answers to common questions about this code of conduct, see the FAQ at
131+
[https://www.contributor-covenant.org/faq][FAQ]. Translations are available at
132+
[https://www.contributor-covenant.org/translations][translations].
133+
134+
[homepage]: https://www.contributor-covenant.org
135+
[v2.1]: https://www.contributor-covenant.org/version/2/1/code_of_conduct.html
136+
[Mozilla CoC]: https://github.com/mozilla/diversity
137+
[FAQ]: https://www.contributor-covenant.org/faq
138+
[translations]: https://www.contributor-covenant.org/translations

0 commit comments

Comments
 (0)