mirrors/dotnet-installer
2
0
Fork 0
Code Issues Pull requests Projects Releases Packages 1 Wiki Activity Actions

Add readme for tool and make script generic

Browse source
This commit is contained in:
kasper 2018-03-30 12:13:31 -04:00
parent b828418021
commit ee24d81648
4 changed files with 59 additions and 42 deletions
Download patch file Download diff file Expand all files Collapse all files

28
Documentation/manpages/tool/README.md Normal file
View file

@ -0,0 +1,28 @@
# Manpage update tool
Utility to update dotnet-cli documentation from https://github.com/dotnet/docs.
## Prerequisites
* Unix OS
* `python` in PATH
* `pandoc` installed
* `pandocfilters` package installed
* `unzip`
* `wget` or `curl`
## Usage
```sh
./update-man-pages.sh
```
## Ubuntu example (from scratch)
```sh
sudo apt install -y pandoc python python-pip wget unzip < /dev/null
sudo pip install pandocfilters
git clone https://github.com/dotnet/cli
./Documentation/manpage/tool/update-man-pages.sh
```

0
Documentation/manpages/man-pandoc-filter.py → Documentation/manpages/tool/man-pandoc-filter.py
View file

31
Documentation/manpages/tool/update-man-pages.sh Executable file
View file

@ -0,0 +1,31 @@
#!/usr/bin/env sh
#
# Copyright (c) .NET Foundation and contributors. All rights reserved.
# Licensed under the MIT license. See LICENSE file in the project root for full license information.
#
MANPAGE_TOOL_DIR=$(cd $(dirname $0); pwd)
cd $MANPAGE_TOOL_DIR/../sdk
echo "Downloading dotnet/docs master"
if [ -x "$(command -v curl)" ]; then
curl -sSLO https://github.com/dotnet/docs/archive/master.zip > /dev/null
elif [ -x "$(command -v wget)" ]; then
wget -q https://github.com/dotnet/docs/archive/master.zip > /dev/null
else
echo "Please install curl or wget to proceed"
exit 1
fi
unzip -o master.zip > /dev/null
rm master.zip*
ls docs-master/docs/core/tools/dotnet*.md | while read -r line;
do
echo "Working on $line"
pandoc -s -t man -V section=1 -V header=".NET Core" --column=500 --filter $MANPAGE_TOOL_DIR/man-pandoc-filter.py "$line" -o "$(basename ${line%.md}.1)"
done
rm -rf docs-master

42
Documentation/manpages/update-man-pages.sh
View file

@ -1,42 +0,0 @@
#!/usr/bin/env sh
#
# Copyright (c) .NET Foundation and contributors. All rights reserved.
# Licensed under the MIT license. See LICENSE file in the project root for full license information.
#
MANPAGE_TOOL_DIR=$(cd $(dirname $0); pwd)
cd $MANPAGE_TOOL_DIR/sdk
pandocVersion=2.1.3
pandocVersionedName=pandoc-$pandocVersion-1-amd64
if [ ! -x "$(command -v pandoc)" ]; then
echo "pandoc $pandocVersion not found, installing"
wget -q https://github.com/jgm/pandoc/releases/download/$pandocVersion/$pandocVersionedName.deb > /dev/null
apt install libgmp10 -y
dpkg -i $pandocVersionedName.deb
rm $pandocVersionedName.deb*
fi
if ! $(python -c "import pandocfilters" &> /dev/null); then
echo "pandocfilters package for python not found, installing v1.4.2"
wget -q https://github.com/jgm/pandocfilters/archive/1.4.2.zip -O pandocfilters-1.4.2.zip > /dev/null
unzip -o pandocfilters-1.4.2.zip > /dev/null
cd pandocfilters-1.4.2
python setup.py install
cd ..
rm -rf pandocfilters-1.4.2*
fi
echo "Downloading dotnet/docs master"
wget -q https://github.com/dotnet/docs/archive/master.zip > /dev/null
unzip -o master.zip > /dev/null
rm master.zip*
ls docs-master/docs/core/tools/dotnet*.md | while read -r line;
do
echo "Working on $line"
pandoc -s -t man -V section=1 -V header=".NET Core" --column=500 --filter $MANPAGE_TOOL_DIR/man-pandoc-filter.py "$line" -o "$(basename ${line%.md}.1)"
done
rm -rf docs-master