forked from nodejs/node-v0.x-archive
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
1,822 changed files
with
32,670 additions
and
79,222 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,31 +1,57 @@ | ||
# vim: set softtabstop=2 shiftwidth=2: | ||
SHELL = bash | ||
|
||
markdowns = $(shell find doc -name '*.md' | grep -v 'index') README.md | ||
|
||
html_docdeps = html/dochead.html \ | ||
html/docfoot.html \ | ||
html/docfoot-script.html \ | ||
scripts/doc-build.sh \ | ||
package.json | ||
|
||
cli_mandocs = $(shell find doc/cli -name '*.md' \ | ||
|sed 's|.md|.1|g' \ | ||
|sed 's|doc/cli/|man/man1/|g' ) \ | ||
man/man1/README.1 \ | ||
man/man1/index.1 | ||
man/man1/npm-README.1 | ||
|
||
api_mandocs = $(shell find doc/api -name '*.md' \ | ||
|sed 's|.md|.3|g' \ | ||
|sed 's|doc/api/|man/man3/|g' ) | ||
|
||
files_mandocs = $(shell find doc/files -name '*.md' \ | ||
|sed 's|.md|.5|g' \ | ||
|sed 's|doc/files/|man/man5/|g' ) \ | ||
man/man5/npm-json.5 \ | ||
man/man5/npm-global.5 | ||
|
||
misc_mandocs = $(shell find doc/misc -name '*.md' \ | ||
|sed 's|.md|.7|g' \ | ||
|sed 's|doc/misc/|man/man7/|g' ) \ | ||
man/man7/index.7 | ||
|
||
cli_htmldocs = $(shell find doc/cli -name '*.md' \ | ||
|grep -v 'index.md' \ | ||
|sed 's|.md|.html|g' \ | ||
|sed 's|doc/cli/|html/doc/|g' ) \ | ||
html/doc/README.html \ | ||
html/doc/index.html | ||
|sed 's|doc/cli/|html/doc/cli/|g' ) \ | ||
html/doc/README.html | ||
|
||
api_htmldocs = $(shell find doc/api -name '*.md' \ | ||
|sed 's|.md|.html|g' \ | ||
|sed 's|doc/api/|html/api/|g' ) | ||
|sed 's|doc/api/|html/doc/api/|g' ) | ||
|
||
files_htmldocs = $(shell find doc/files -name '*.md' \ | ||
|sed 's|.md|.html|g' \ | ||
|sed 's|doc/files/|html/doc/files/|g' ) \ | ||
html/doc/files/npm-json.html \ | ||
html/doc/files/npm-global.html | ||
|
||
mandocs = $(api_mandocs) $(cli_mandocs) | ||
misc_htmldocs = $(shell find doc/misc -name '*.md' \ | ||
|sed 's|.md|.html|g' \ | ||
|sed 's|doc/misc/|html/doc/misc/|g' ) \ | ||
html/doc/index.html | ||
|
||
htmldocs = $(api_htmldocs) $(cli_htmldocs) | ||
mandocs = $(api_mandocs) $(cli_mandocs) $(files_mandocs) $(misc_mandocs) | ||
|
||
htmldocs = $(api_htmldocs) $(cli_htmldocs) $(files_htmldocs) $(misc_htmldocs) | ||
|
||
all: doc | ||
|
||
|
@@ -58,17 +84,14 @@ doc-clean: | |
rm -rf \ | ||
node_modules/ronn \ | ||
node_modules/.bin/ronn \ | ||
.building_ronn \ | ||
doc/cli/index.md \ | ||
doc/api/index.md \ | ||
$(api_mandocs) \ | ||
$(cli_mandocs) \ | ||
$(api_htmldocs) \ | ||
$(cli_htmldocs) \ | ||
&>/dev/null || true | ||
.building_ronn \ | ||
html/doc \ | ||
html/api \ | ||
man/man* | ||
|
||
# use `npm install ronn` for this to work. | ||
man/man1/README.1: README.md scripts/doc-build.sh package.json | ||
man/man1/npm-README.1: README.md scripts/doc-build.sh package.json | ||
@[ -d man/man1 ] || mkdir -p man/man1 | ||
scripts/doc-build.sh $< $@ | ||
|
||
man/man1/%.1: doc/cli/%.md scripts/doc-build.sh package.json | ||
|
@@ -79,17 +102,54 @@ man/man3/%.3: doc/api/%.md scripts/doc-build.sh package.json | |
@[ -d man/man3 ] || mkdir -p man/man3 | ||
scripts/doc-build.sh $< $@ | ||
|
||
html/doc/README.html: README.md html/dochead.html html/docfoot.html scripts/doc-build.sh package.json | ||
man/man5/npm-json.5: man/man5/package.json.5 | ||
cp $< $@ | ||
|
||
man/man5/npm-global.5: man/man5/npm-folders.5 | ||
cp $< $@ | ||
|
||
man/man5/%.5: doc/files/%.md scripts/doc-build.sh package.json | ||
@[ -d man/man5 ] || mkdir -p man/man5 | ||
scripts/doc-build.sh $< $@ | ||
|
||
html/doc/%.html: doc/cli/%.md html/dochead.html html/docfoot.html scripts/doc-build.sh package.json | ||
doc/misc/npm-index.md: scripts/index-build.js package.json | ||
node scripts/index-build.js > $@ | ||
|
||
html/doc/index.html: doc/misc/npm-index.md $(html_docdeps) | ||
@[ -d html/doc ] || mkdir -p html/doc | ||
scripts/doc-build.sh $< $@ | ||
|
||
html/api/%.html: doc/api/%.md html/dochead.html html/docfoot.html scripts/doc-build.sh package.json | ||
man/man7/%.7: doc/misc/%.md scripts/doc-build.sh package.json | ||
@[ -d man/man7 ] || mkdir -p man/man7 | ||
scripts/doc-build.sh $< $@ | ||
|
||
doc/cli/index.md: $(markdowns) scripts/index-build.js scripts/doc-build.sh package.json | ||
node scripts/index-build.js > $@ | ||
html/doc/README.html: README.md $(html_docdeps) | ||
@[ -d html/doc ] || mkdir -p html/doc | ||
scripts/doc-build.sh $< $@ | ||
|
||
html/doc/cli/%.html: doc/cli/%.md $(html_docdeps) | ||
@[ -d html/doc/cli ] || mkdir -p html/doc/cli | ||
scripts/doc-build.sh $< $@ | ||
|
||
html/doc/api/%.html: doc/api/%.md $(html_docdeps) | ||
@[ -d html/doc/api ] || mkdir -p html/doc/api | ||
scripts/doc-build.sh $< $@ | ||
|
||
html/doc/files/npm-json.html: html/doc/files/package.json.html | ||
cp $< $@ | ||
html/doc/files/npm-global.html: html/doc/files/npm-folders.html | ||
cp $< $@ | ||
|
||
html/doc/files/%.html: doc/files/%.md $(html_docdeps) | ||
@[ -d html/doc/files ] || mkdir -p html/doc/files | ||
scripts/doc-build.sh $< $@ | ||
|
||
html/doc/misc/%.html: doc/misc/%.md $(html_docdeps) | ||
@[ -d html/doc/misc ] || mkdir -p html/doc/misc | ||
scripts/doc-build.sh $< $@ | ||
|
||
|
||
|
||
|
||
node_modules/.bin/ronn: | ||
node cli.js install ronn | ||
|
@@ -102,9 +162,10 @@ test: | |
node cli.js test | ||
|
||
publish: link doc | ||
@git push origin :v$(shell npm -v) || true | ||
@npm unpublish npm@$(shell npm -v) || true | ||
git clean -fd | ||
@git push origin :v$(shell npm -v) 2>&1 || true | ||
@npm unpublish npm@$(shell npm -v) 2>&1 || true | ||
git clean -fd &&\ | ||
git push origin &&\ | ||
git push origin --tags &&\ | ||
npm publish &&\ | ||
npm tag npm@$(shell npm -v) $(shell npm -v | awk -F. '{print $$1 "." $$2}') &&\ | ||
|
@@ -113,18 +174,36 @@ publish: link doc | |
|
||
docpublish: doc-publish | ||
doc-publish: doc | ||
# legacy urls | ||
for f in $$(find html/doc/{cli,files,misc}/ -name '*.html'); do \ | ||
j=$$(basename $$f | sed 's|^npm-||g'); \ | ||
if ! [ -f html/doc/$$j ] && [ $$j != README.html ] && [ $$j != index.html ]; then \ | ||
perl -pi -e 's/ href="\.\.\// href="/g' <$$f >html/doc/$$j; \ | ||
fi; \ | ||
done | ||
mkdir -p html/api | ||
for f in $$(find html/doc/api/ -name '*.html'); do \ | ||
j=$$(basename $$f | sed 's|^npm-||g'); \ | ||
perl -pi -e 's/ href="\.\.\// href="/g' <$$f >html/api/$$j; \ | ||
done | ||
rsync -vazu --stats --no-implied-dirs --delete \ | ||
html/doc/ \ | ||
[email protected]:/home/node/npm-www/doc | ||
rsync -vazu --stats --no-implied-dirs --delete \ | ||
html/api/ \ | ||
[email protected]:/home/node/npm-www/api | ||
html/doc/* \ | ||
[email protected]:/home/node/npm-www/doc | ||
rsync -vazu --stats --no-implied-dirs --delete \ | ||
html/static/webfonts/ \ | ||
[email protected]:/home/node/npm-www/static/webfonts | ||
html/static/webfonts/ \ | ||
[email protected]:/home/node/npm-www/static/webfonts | ||
rsync -vazu --stats --no-implied-dirs --delete \ | ||
html/static/style.css \ | ||
[email protected]:/home/node/npm-www/static/ | ||
html/static/style.css \ | ||
[email protected]:/home/node/npm-www/static/ | ||
#cleanup | ||
rm -rf html/api | ||
for f in html/doc/*.html; do \ | ||
case $$f in \ | ||
html/doc/README.html) continue ;; \ | ||
html/doc/index.html) continue ;; \ | ||
*) rm $$f ;; \ | ||
esac; \ | ||
done | ||
|
||
zip-publish: release | ||
scp release/* [email protected]:dist/npm/ | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file was deleted.
Oops, something went wrong.
This file was deleted.
Oops, something went wrong.
This file was deleted.
Oops, something went wrong.
File renamed without changes.
File renamed without changes.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,22 @@ | ||
npm-commands(3) -- npm commands | ||
=============================== | ||
|
||
## SYNOPSIS | ||
|
||
npm.commands[<command>](args, callback) | ||
|
||
## DESCRIPTION | ||
|
||
npm comes with a full set of commands, and each of the commands takes a | ||
similar set of arguments. | ||
|
||
In general, all commands on the command object take an **array** of positional | ||
argument **strings**. The last argument to any function is a callback. Some | ||
commands are special and take other optional arguments. | ||
|
||
All commands have their own man page. See `man npm-<command>` for command-line | ||
usage, or `man 3 npm-<command>` for programmatic usage. | ||
|
||
## SEE ALSO | ||
|
||
* npm-index(7) |
File renamed without changes.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,34 @@ | ||
npm-deprecate(3) -- Deprecate a version of a package | ||
==================================================== | ||
|
||
## SYNOPSIS | ||
|
||
npm.commands.deprecate(args, callback) | ||
|
||
## DESCRIPTION | ||
|
||
This command will update the npm registry entry for a package, providing | ||
a deprecation warning to all who attempt to install it. | ||
|
||
The 'args' parameter must have exactly two elements: | ||
|
||
* `package[@version]` | ||
|
||
The `version` portion is optional, and may be either a range, or a | ||
specific version, or a tag. | ||
|
||
* `message` | ||
|
||
The warning message that will be printed whenever a user attempts to | ||
install the package. | ||
|
||
Note that you must be the package owner to deprecate something. See the | ||
`owner` and `adduser` help topics. | ||
|
||
To un-deprecate a package, specify an empty string (`""`) for the `message` argument. | ||
|
||
## SEE ALSO | ||
|
||
* npm-publish(3) | ||
* npm-unpublish(3) | ||
* npm-registry(7) |
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,29 @@ | ||
npm init(3) -- Interactively create a package.json file | ||
======================================================= | ||
|
||
## SYNOPSIS | ||
|
||
npm.commands.init(args, callback) | ||
|
||
## DESCRIPTION | ||
|
||
This will ask you a bunch of questions, and then write a package.json for you. | ||
|
||
It attempts to make reasonable guesses about what you want things to be set to, | ||
and then writes a package.json file with the options you've selected. | ||
|
||
If you already have a package.json file, it'll read that first, and default to | ||
the options in there. | ||
|
||
It is strictly additive, so it does not delete options from your package.json | ||
without a really good reason to do so. | ||
|
||
Since this function expects to be run on the command-line, it doesn't work very | ||
well as a programmatically. The best option is to roll your own, and since | ||
JavaScript makes it stupid simple to output formatted JSON, that is the | ||
preferred method. If you're sure you want to handle command-line prompting, | ||
then go ahead and use this programmatically. | ||
|
||
## SEE ALSO | ||
|
||
package.json(5) |
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
Oops, something went wrong.