1#!/bin/sh 2 3# Generate doxygen documentation with a full config.h (this ensures that every 4# available flag is documented, and avoids warnings about documentation 5# without a corresponding #define). 6# 7# /!\ This must not be a Makefile target, as it would create a race condition 8# when multiple targets are invoked in the same parallel build. 9# 10# Copyright The Mbed TLS Contributors 11# SPDX-License-Identifier: Apache-2.0 OR GPL-2.0-or-later 12# 13# This file is provided under the Apache License 2.0, or the 14# GNU General Public License v2.0 or later. 15# 16# ********** 17# Apache License 2.0: 18# 19# Licensed under the Apache License, Version 2.0 (the "License"); you may 20# not use this file except in compliance with the License. 21# You may obtain a copy of the License at 22# 23# http://www.apache.org/licenses/LICENSE-2.0 24# 25# Unless required by applicable law or agreed to in writing, software 26# distributed under the License is distributed on an "AS IS" BASIS, WITHOUT 27# WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 28# See the License for the specific language governing permissions and 29# limitations under the License. 30# 31# ********** 32# 33# ********** 34# GNU General Public License v2.0 or later: 35# 36# This program is free software; you can redistribute it and/or modify 37# it under the terms of the GNU General Public License as published by 38# the Free Software Foundation; either version 2 of the License, or 39# (at your option) any later version. 40# 41# This program is distributed in the hope that it will be useful, 42# but WITHOUT ANY WARRANTY; without even the implied warranty of 43# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 44# GNU General Public License for more details. 45# 46# You should have received a copy of the GNU General Public License along 47# with this program; if not, write to the Free Software Foundation, Inc., 48# 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA. 49# 50# ********** 51 52set -eu 53 54CONFIG_H='include/mbedtls/config.h' 55 56if [ -r $CONFIG_H ]; then :; else 57 echo "$CONFIG_H not found" >&2 58 exit 1 59fi 60 61CONFIG_BAK=${CONFIG_H}.bak 62cp -p $CONFIG_H $CONFIG_BAK 63 64scripts/config.pl realfull 65make apidoc 66 67mv $CONFIG_BAK $CONFIG_H 68