1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768 |
- #!/bin/sh
- # Generate doxygen documentation with a full config.h (this ensures that every
- # available flag is documented, and avoids warnings about documentation
- # without a corresponding #define).
- #
- # /!\ This must not be a Makefile target, as it would create a race condition
- # when multiple targets are invoked in the same parallel build.
- #
- # Copyright The Mbed TLS Contributors
- # SPDX-License-Identifier: Apache-2.0 OR GPL-2.0-or-later
- #
- # This file is provided under the Apache License 2.0, or the
- # GNU General Public License v2.0 or later.
- #
- # **********
- # Apache License 2.0:
- #
- # Licensed 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.
- #
- # **********
- #
- # **********
- # GNU General Public License v2.0 or later:
- #
- # This program is free software; you can redistribute it and/or modify
- # it under the terms of the GNU General Public License as published by
- # the Free Software Foundation; either version 2 of the License, or
- # (at your option) any later version.
- #
- # This program is distributed in the hope that it will be useful,
- # but WITHOUT ANY WARRANTY; without even the implied warranty of
- # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
- # GNU General Public License for more details.
- #
- # You should have received a copy of the GNU General Public License along
- # with this program; if not, write to the Free Software Foundation, Inc.,
- # 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
- #
- # **********
- set -eu
- CONFIG_H='include/mbedtls/config.h'
- if [ -r $CONFIG_H ]; then :; else
- echo "$CONFIG_H not found" >&2
- exit 1
- fi
- CONFIG_BAK=${CONFIG_H}.bak
- cp -p $CONFIG_H $CONFIG_BAK
- scripts/config.pl realfull
- make apidoc
- mv $CONFIG_BAK $CONFIG_H
|