Any new files developed at the ASF should have ASF headers [1] you
also note it down;t have a copyright line.
1. https://www.apache.org/legal/src-headers.html#headers
That page gives the text of the ASF header but not the form of the
header in code.
The NuttX coding standard would add to this in .C and C++ files:
/****************************************************************************
* Licensed to the Apache Software Foundation (ASF) under one
* or more contributor license agreements. See the NOTICE file
* distributed with this work for additional information
* regarding copyright ownership. The ASF licenses this file
* to you 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
*
* http://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.
****************************************************************************/
Files that use # for a comment would be in a similar box compose of #
characters.
Is there any problem with this? I will update the NuttX coding
standard to match.
A couple more questions:
1) Historically, we have put the file name at the top of each file.
This form would retain that convention. Is this acceptable?
2) The line length in the coding standard is 78 bytes. The longest line
in the same is 62 bytes. That looks weird. Can we use the 78 character
line width?
This is what I am committing for the change you requested:
<pre>
/****************************************************************************
* sched/sched/sched_getcpu.c
*
* Licensed to the Apache Software Foundation (ASF) under one or more
* contributor license agreements. See the NOTICE file distributed with
* this work for additional information regarding copyright ownership. The
* ASF licenses this file to you 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
*
* http://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.
*
****************************************************************************/
</pre>
Not sure how to force pre-formatted text
Greg
