Add comments to check-c++-types.sh
Commit Message
I would like to add some comments to scripts/check-c++-types.sh to make
it more obvious what it is doing. Does this text look OK?
Steve Ellcey
sellcey@caviumnetworks.com
2016-12-08 Steve Ellcey <sellcey@caviumnetworks.com>
* scripts/check-c++-types.sh: Add comments.
Comments
Since no one objected to my text, I am going to check this in as an
obvious change.
Steve Ellcey
sellcey@caviumnetworks.com
On Thu, 2016-12-08 at 08:27 -0800, Steve Ellcey wrote:
> I would like to add some comments to scripts/check-c++-types.sh to
> make
> it more obvious what it is doing. Does this text look OK?
>
> Steve Ellcey
> sellcey@caviumnetworks.com
>
>
> 2016-12-08 Steve Ellcey <sellcey@caviumnetworks.com>
>
> * scripts/check-c++-types.sh: Add comments.
>
>
>
> diff --git a/scripts/check-c++-types.sh b/scripts/check-c++-types.sh
> index 489c4f0..f82ffff 100755
> --- a/scripts/check-c++-types.sh
> +++ b/scripts/check-c++-types.sh
> @@ -15,6 +15,14 @@
> # You should have received a copy of the GNU Lesser General Public
> # License along with the GNU C Library; if not, see
> # <http://www.gnu.org/licenses/>.
> +
> +# This script creates a list of data types where each type is
> followed
> +# by the C++ mangled name for that type. That list is then compared
> +# against the list in the c++-types.data file for the platform being
> +# checked. Any difference between the two would mean that the C++
> ABI
> +# had changed and that should not happen even if the change is
> compatible
> +# at the C language level.
> +
> #
> # The list of data types has been created with
> # cat <<EOF |
@@ -15,6 +15,14 @@
# You should have received a copy of the GNU Lesser General Public
# License along with the GNU C Library; if not, see
# <http://www.gnu.org/licenses/>.
+
+# This script creates a list of data types where each type is followed
+# by the C++ mangled name for that type. That list is then compared
+# against the list in the c++-types.data file for the platform being
+# checked. Any difference between the two would mean that the C++ ABI
+# had changed and that should not happen even if the change is compatible
+# at the C language level.
+
#
# The list of data types has been created with
# cat <<EOF |