ichthyo/LUMIERA.clone
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions
LUMIERA.clone/doc/devel/rfc/CodingStyle.txt

99 lines
2.4 KiB
Text
Raw Permalink Normal View History

Import old DesignProcess into rfc_pending
2010-07-23 18:24:30 +02:00
Design Process : Coding Style
=============================
clean-up: comb through the historical pages to fix markup errors Some sections of the Lumiera website document meeting minutes, discussion protocols and design proposals from the early days of the project; these pages were initially authored in the »Moin Moin Wiki« operated by Cehteh on pipapo.org at that time; this wiki backed the first publications of the »Cinelerra-3« initiative, which turned into the Lumiera project eventually. Some years later, those pages were transliterated into Asciidoc semi-automatically, resulting in a lot of broken markup and links. This is a long standing maintenance problem problem plaguing the Lumiera website, since those breakages cause a lot of warnings and flood the logs of any linkchecker run.
2025-09-08 04:04:39 +02:00
[options="autowidth"]
|====================================
|*State* | _Final_
|*Date* | _2007-06-27_
|*Proposed by* | ct
|====================================
Import old DesignProcess into rfc_pending
2010-07-23 18:24:30 +02:00
CodingStyle
-----------
Define coding style standard which we will use.
Description
~~~~~~~~~~~
clean-up: sourcefile layout and spell checking Uniform sequence at start of source files - copyright claim - license - file comment - header guard - lumiera includes - library / system includes Lumiera uses Brittish spelling. Add an according note to the styleguide.
2014-10-15 23:08:53 +02:00
We need to agree on some coding style, IMHO consistency is the most important
Line wrapped all rfc's
2010-07-24 16:48:32 +02:00
part with this, no matter which style we use.
Import old DesignProcess into rfc_pending
2010-07-23 18:24:30 +02:00
clean-up: link maintenance - use HTTPS - avoid redirects - supply Archive.org snapshots for old resources
2025-09-02 19:42:49 +02:00
See https://en.wikipedia.org/wiki/Indentation_style[Wikipedia: Indentation Style]
Import old DesignProcess into rfc_pending
2010-07-23 18:24:30 +02:00
.Notes:
* no tabs, use spaces!
.Proposed:
clean-up: sourcefile layout and spell checking Uniform sequence at start of source files - copyright claim - license - file comment - header guard - lumiera includes - library / system includes Lumiera uses Brittish spelling. Add an according note to the styleguide.
2014-10-15 23:08:53 +02:00
* K&R by _ichthyo_
clean-up: comb through the historical pages to fix markup errors Some sections of the Lumiera website document meeting minutes, discussion protocols and design proposals from the early days of the project; these pages were initially authored in the »Moin Moin Wiki« operated by Cehteh on pipapo.org at that time; this wiki backed the first publications of the »Cinelerra-3« initiative, which turned into the Lumiera project eventually. Some years later, those pages were transliterated into Asciidoc semi-automatically, resulting in a lot of broken markup and links. This is a long standing maintenance problem problem plaguing the Lumiera website, since those breakages cause a lot of warnings and flood the logs of any linkchecker run.
2025-09-08 04:04:39 +02:00
** compact and well known
clean-up: sourcefile layout and spell checking Uniform sequence at start of source files - copyright claim - license - file comment - header guard - lumiera includes - library / system includes Lumiera uses Brittish spelling. Add an according note to the styleguide.
2014-10-15 23:08:53 +02:00
* GNU by _cehteh_
clean-up: comb through the historical pages to fix markup errors Some sections of the Lumiera website document meeting minutes, discussion protocols and design proposals from the early days of the project; these pages were initially authored in the »Moin Moin Wiki« operated by Cehteh on pipapo.org at that time; this wiki backed the first publications of the »Cinelerra-3« initiative, which turned into the Lumiera project eventually. Some years later, those pages were transliterated into Asciidoc semi-automatically, resulting in a lot of broken markup and links. This is a long standing maintenance problem problem plaguing the Lumiera website, since those breakages cause a lot of warnings and flood the logs of any linkchecker run.
2025-09-08 04:04:39 +02:00
** imo the best readability (albeit little strange)
** Lumiera might apply as official GNU project someday
Import old DesignProcess into rfc_pending
2010-07-23 18:24:30 +02:00
Another question: __how to write identifiers?__
.Proposed:
clean-up: sourcefile layout and spell checking Uniform sequence at start of source files - copyright claim - license - file comment - header guard - lumiera includes - library / system includes Lumiera uses Brittish spelling. Add an according note to the styleguide.
2014-10-15 23:08:53 +02:00
* ichthyo: use CamelCase, start ClassNames upper case and variableNames
in lower case. Make all namespaces and package (dir) names completely lowercase
Import old DesignProcess into rfc_pending
2010-07-23 18:24:30 +02:00
Tasks
^^^^^
* Bouml config to generate this style
* footers (or headers) to configure common editors to use this style by default
Conclusion
----------
we agreed on GNU style
re-read some of the RfC, fix small markup issues
2011-04-16 02:47:42 +02:00
CT:: '2007-07-03 04:04'
Import old DesignProcess into rfc_pending
2010-07-23 18:24:30 +02:00
Comments
--------
clean-up: comb through the historical pages to fix markup errors Some sections of the Lumiera website document meeting minutes, discussion protocols and design proposals from the early days of the project; these pages were initially authored in the »Moin Moin Wiki« operated by Cehteh on pipapo.org at that time; this wiki backed the first publications of the »Cinelerra-3« initiative, which turned into the Lumiera project eventually. Some years later, those pages were transliterated into Asciidoc semi-automatically, resulting in a lot of broken markup and links. This is a long standing maintenance problem problem plaguing the Lumiera website, since those breakages cause a lot of warnings and flood the logs of any linkchecker run.
2025-09-08 04:04:39 +02:00
Since ct called spaces instead of tabs first, we should stick to that. I
Line wrapped all rfc's
2010-07-24 16:48:32 +02:00
think all other reasons will lead us to nowhere!
Import old DesignProcess into rfc_pending
2010-07-23 18:24:30 +02:00
Line wrapped all rfc's
2010-07-24 16:48:32 +02:00
Although I'm used to a BSD/KNF-like coding style I will try the GNU one. After
clean-up: comb through the historical pages to fix markup errors Some sections of the Lumiera website document meeting minutes, discussion protocols and design proposals from the early days of the project; these pages were initially authored in the »Moin Moin Wiki« operated by Cehteh on pipapo.org at that time; this wiki backed the first publications of the »Cinelerra-3« initiative, which turned into the Lumiera project eventually. Some years later, those pages were transliterated into Asciidoc semi-automatically, resulting in a lot of broken markup and links. This is a long standing maintenance problem problem plaguing the Lumiera website, since those breakages cause a lot of warnings and flood the logs of any linkchecker run.
2025-09-08 04:04:39 +02:00
all, the wikipedia page mentions no disadvantages of that style 😊
Import old DesignProcess into rfc_pending
2010-07-23 18:24:30 +02:00
re-read some of the RfC, fix small markup issues
2011-04-16 02:47:42 +02:00
MichaelPloujnikov:: '2007-06-27 17:17'
Import old DesignProcess into rfc_pending
2010-07-23 18:24:30 +02:00
Line wrapped all rfc's
2010-07-24 16:48:32 +02:00
I just proposed K&R because it is widely accepted. Personally, I was never very
clean-up: sourcefile layout and spell checking Uniform sequence at start of source files - copyright claim - license - file comment - header guard - lumiera includes - library / system includes Lumiera uses Brittish spelling. Add an according note to the styleguide.
2014-10-15 23:08:53 +02:00
fond of K&R style, I always preferred putting opening braces to the left. I
never used GNU style until now, but it looks somewhat appealing to me. (btw,
clean-up: comb through the historical pages to fix markup errors Some sections of the Lumiera website document meeting minutes, discussion protocols and design proposals from the early days of the project; these pages were initially authored in the »Moin Moin Wiki« operated by Cehteh on pipapo.org at that time; this wiki backed the first publications of the »Cinelerra-3« initiative, which turned into the Lumiera project eventually. Some years later, those pages were transliterated into Asciidoc semi-automatically, resulting in a lot of broken markup and links. This is a long standing maintenance problem problem plaguing the Lumiera website, since those breakages cause a lot of warnings and flood the logs of any linkchecker run.
2025-09-08 04:04:39 +02:00
ECLIPSE comes with presets for all this styles 😛 ). Anyhow, I can adapt to
Rewrap all RFC's This reverts commit 65bae31de4103abb7d7b6fd004a8315973d3144a. and reprocessed the wrapping. Note that the automatic wrapping is not perfect, some manual fixing by removing some hunks was required.
2010-07-26 02:54:14 +02:00
most any style. The only thing I really dislike is using tabs (with the
clean-up: comb through the historical pages to fix markup errors Some sections of the Lumiera website document meeting minutes, discussion protocols and design proposals from the early days of the project; these pages were initially authored in the »Moin Moin Wiki« operated by Cehteh on pipapo.org at that time; this wiki backed the first publications of the »Cinelerra-3« initiative, which turned into the Lumiera project eventually. Some years later, those pages were transliterated into Asciidoc semi-automatically, resulting in a lot of broken markup and links. This is a long standing maintenance problem problem plaguing the Lumiera website, since those breakages cause a lot of warnings and flood the logs of any linkchecker run.
2025-09-08 04:04:39 +02:00
exception of database DDLs and CSound files, where tab are actually helpful) 😊
Import old DesignProcess into rfc_pending
2010-07-23 18:24:30 +02:00
re-read some of the RfC, fix small markup issues
2011-04-16 02:47:42 +02:00
Ichthyo:: '2007-06-27 20:55'
clean-up: comb through the historical pages to fix markup errors Some sections of the Lumiera website document meeting minutes, discussion protocols and design proposals from the early days of the project; these pages were initially authored in the »Moin Moin Wiki« operated by Cehteh on pipapo.org at that time; this wiki backed the first publications of the »Cinelerra-3« initiative, which turned into the Lumiera project eventually. Some years later, those pages were transliterated into Asciidoc semi-automatically, resulting in a lot of broken markup and links. This is a long standing maintenance problem problem plaguing the Lumiera website, since those breakages cause a lot of warnings and flood the logs of any linkchecker run.
2025-09-08 04:04:39 +02:00
Many years later -- we are still using GNU style and over time have developed
a »Lumiera flavour« which plays well with C++, templates and λ-functions.
A striking consequence is that the code looks light, favours short functions,
is rather vertically oriented and is easy to skim while scrolling.
-> see our link:/x/CodeStyle.html[Style guide].
Ichthyo:: '2025-09-05'
Import old DesignProcess into rfc_pending
2010-07-23 18:24:30 +02:00
''''
clean-up: comb through the historical pages to fix markup errors Some sections of the Lumiera website document meeting minutes, discussion protocols and design proposals from the early days of the project; these pages were initially authored in the »Moin Moin Wiki« operated by Cehteh on pipapo.org at that time; this wiki backed the first publications of the »Cinelerra-3« initiative, which turned into the Lumiera project eventually. Some years later, those pages were transliterated into Asciidoc semi-automatically, resulting in a lot of broken markup and links. This is a long standing maintenance problem problem plaguing the Lumiera website, since those breakages cause a lot of warnings and flood the logs of any linkchecker run.
2025-09-08 04:04:39 +02:00
Back to link:/x/DesignProcess.html[Lumiera Design Process overview]
Reference in a new issue Copy permalink