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

Merge pull request #9081 from kasper3/master

Browse source 
Update dotnet manpages for Unix
This commit is contained in:
Livar 2018-04-18 10:13:01 -07:00 • committed by GitHub
commit 289591d00c
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
3 changed files with 28 additions and 18 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

16
Documentation/manpages/sdk/dotnet-new.1
View file

@ -301,6 +301,13 @@ For example if the directory already contains a project, it doesn't list all pro
The language of the template to create.
The language accepted varies by the template (see defaults in the arguments section).
Not valid for some templates.
.IP
.nf
\f[C]
>\ [!NOTE]
>\ Some\ shells\ interpret\ `#`\ as\ a\ special\ character.\ In\ those\ cases,\ you\ need\ to\ enclose\ the\ language\ parameter\ value,\ such\ as\ `dotnet\ new\ console\ \-lang\ "F#"`.
\f[]
.fi
.PP
\f[C]\-n|\-\-name\ <OUTPUT_NAME>\f[]
.PP
@ -350,6 +357,13 @@ For example if the directory already contains a project, it doesn't list all pro
The language of the template to create.
The language accepted varies by the template (see defaults in the arguments section).
Not valid for some templates.
.IP
.nf
\f[C]
>\ [!NOTE]
>\ Some\ shells\ interpret\ `#`\ as\ a\ special\ character.\ In\ those\ cases,\ you\ need\ to\ enclose\ the\ language\ parameter\ value,\ such\ as\ `dotnet\ new\ console\ \-lang\ "F#"`.
\f[]
.fi
.PP
\f[C]\-n|\-\-name\ <OUTPUT_NAME>\f[]
.PP
@ -548,7 +562,7 @@ The default value is \f[C]false\f[].
.PP
Create an F# console application project in the current directory:
.PP
\f[C]dotnet\ new\ console\ \-lang\ f#\f[]
\f[C]dotnet\ new\ console\ \-lang\ F#\f[]
.PP
Create a .NET Standard class library project in the specified directory (available only with .NET Core 2.0 SDK or later versions):
.PP

27
Documentation/manpages/tool/README.md
View file

@ -20,23 +20,16 @@ Utility to update dotnet-cli documentation from https://github.com/dotnet/docs.
## Ubuntu example (from scratch)
```sh
sudo apt install -y pandoc python python-pip wget unzip < /dev/null
sudo pip install pandocfilters
apt update
apt install -y jq curl python python-pip wget unzip git < /dev/null
pip install pandocfilters
pandocVersion=$(curl -s https://api.github.com/repos/jgm/pandoc/releases/latest | jq -r ".tag_name")
pandocVersionedName="pandoc-$pandocVersion-1-amd64.deb"
curl -sLO https://github.com/jgm/pandoc/releases/download/$pandocVersion/$pandocVersionedName > /dev/null
dpkg -i $pandocVersionedName
rm $pandocVersionedName*
git clone https://github.com/dotnet/cli
./cli/Documentation/manpage/tool/update-man-pages.sh
./cli/Documentation/manpages/tool/update-man-pages.sh
```
The version of pandoc is printed in first line as code comment in `.1` (manpage) files.
If your version of pandoc is older than (or even equal to) the last modifed version,
please install the latest stable version of pandoc from https://github.com/jgm/pandoc/releases (deb file for Ubuntu):
```sh
wget -q https://github.com/jgm/pandoc/releases/download/$pandocVersion/$pandocVersionedName.deb > /dev/null
# or
# curl -sSLO https://github.com/jgm/pandoc/releases/download/$pandocVersion/$pandocVersionedName.deb > /dev/null
sudo dpkg -i $pandocVersionedName.deb
rm $pandocVersionedName.deb*
```
after that update manpages by calling `update-man-pages.sh` script.

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

@ -19,7 +19,10 @@ else
exit 1
fi
echo "Extracting master.zip"
unzip -o master.zip > /dev/null
echo "Removing master.zip"
rm master.zip*
ls docs-master/docs/core/tools/dotnet*.md | while read -r line;