Skip to content

Commit

Permalink
[skip ci] fix relative links
Browse files Browse the repository at this point in the history
  • Loading branch information
Forthoney committed Dec 17, 2023
1 parent c47e5fc commit bb90e0a
Show file tree
Hide file tree
Showing 4 changed files with 18 additions and 17 deletions.
5 changes: 3 additions & 2 deletions docs/ci.md
Original file line number Diff line number Diff line change
@@ -1,12 +1,13 @@

## Continuous Integration

<!-- link is broken -->
A text-based continuous integration (CI) sever is set up at [pash.ndr.md](http://pash.ndr.md).
The focus of CI is to monitor correctness, not performance:
The focus of CI is to monitor correctness, not performance:
it runs all of PaSh's benchmarks, with small inputs, and compares results with the sequential execution.
It additionally runs and reports on the tests from the Smoosh suite.

#### Summary
#### Summary

To get the summary of the latest 5 builds:

Expand Down
6 changes: 3 additions & 3 deletions docs/contributing.md
Original file line number Diff line number Diff line change
Expand Up @@ -124,7 +124,7 @@ Restart-Computer
Run the `wsl` command (or find the installed Linux distribution in Windows Start menu and run it).
After a few minutes of installation, enter a username and password for the internal WSL account to be created.

Continue the PaSh installation process from [here](https://github.com/binpash/pash/blob/main/docs/tutorial/tutorial.md#installation) inside the WSL installation.
Continue the PaSh installation process from [here](tutorial.md#installation) inside the WSL installation.


## Docker TODO
Expand All @@ -137,7 +137,7 @@ Here are commands related to launching a screen session:
* `screen` -> start a new session
* `screen -ls` -> show all screen sessions in this machine
* `screen -x <ID>` -> attach to screen with id `<ID>`, as shown by `-ls` above.
* `screen -x <user>/<pash>` -> attach to session `pash` of user `user`, assuming it exists/running;
* `screen -x <user>/<pash>` -> attach to session `pash` of user `user`, assuming it exists/running;

When in a `screen` session, all `screen`-related commands are prefixed by `ctr-a` (which means pressing `ctrl` and `a` _together_, and _then_ pressing the followup character). Here are the 5 most useful commands:
* `ctrl-a c` -> create­a new window in the current session
Expand Down Expand Up @@ -168,7 +168,7 @@ git merge master # fetch changes from main/master

(You can use `rebase` instead of `merge` if your branch is local and hasn't been pushed to GitHub, but `merge` if your branch is already pushed.)

## Process for Using EC2 Instance
## Process for Using EC2 Instance

A reason to use Amazon Elastic Compute Cloud (EC2) is having insufficient computing power in your local machine. The steps to do are as follows. The generated key is of the form user@hostname.

Expand Down
6 changes: 3 additions & 3 deletions docs/install.md
Original file line number Diff line number Diff line change
Expand Up @@ -49,7 +49,7 @@ We refresh this image (as well as other images) on every major release.
[//]: # "TODO(@nvasilakis, @dkarnikis): Need to automate this per release."

_Build Image (Latest Commit):_
To build the latest Docker container, run `docker build` in [scripts/docker](https://github.com/binpash/pash/tree/main/scripts/docker):
To build the latest Docker container, run `docker build` in [scripts/docker](../scripts/docker):
```sh
git clone [email protected]:binpash/pash.git
cd pash/scripts/docker/
Expand All @@ -64,11 +64,11 @@ docker run --name pash-play -it pash:latest
```

PaSh can be found in the container's `/opt/pash` directory, so run `cd pash; git pull` to fetch the latest updates.
More information in the [pash-on-docker guide](../contributing/contrib.md#pash-on-docker-a-pocket-guide).
More information in the [pash-on-docker guide](contributing.md#pash-on-docker-a-pocket-guide).

### Windows using WSL

To run PaSh on windows without Docker, install [WSL](https://docs.microsoft.com/en-us/windows/wsl/install-win10).
A short tutorial is included in the [contributing](../contributing/contrib.md) guide.
A short tutorial is included in the [contributing](contributing.md) guide.

[//]: # "TODO(@nvasilakis, @dkarnikis): Need to add instructions for OS X."
18 changes: 9 additions & 9 deletions docs/tutorial.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
Quick jump: [Introduction](#introduction) | [Running Scripts](#running-scripts) | [What Next?](#what-next)

This short tutorial covers the `pash`'s main functionality.
Before proceeding, make sure [you have installed PaSh](../install/)
Before proceeding, make sure [you have installed PaSh](install.md)

## Introduction

Expand All @@ -17,11 +17,11 @@ Consider the following spell-checking script, applied to two large markdown file

```sh
# spell-checking.sh
cat f1.md f2.md |
cat f1.md f2.md |
tr A-Z a-z |
tr -cs A-Za-z '\n' |
sort |
uniq |
uniq |
comm -13 dict.txt - > out
cat out | wc -l | sed 's/$/ mispelled words!/'
```
Expand Down Expand Up @@ -98,7 +98,7 @@ On our evaluation infrastructure, the script takes about 41s.
To execute it using `pash` with 2x-parallelism:
```sh
time $PASH_TOP/pa.sh -w 2 -d 1 --log_file pash.log demo-spell.sh > pash-spell.out
```
```
On our evaluation infrastructure, the 2x-parallel script takes about 28s.

You can check that the results are correct by:
Expand All @@ -109,7 +109,7 @@ diff spell.out pash-spell.out
Assuming you have more than 8 CPUs, you could also execute it with 8x-parallelism using:
```sh
time $PASH_TOP/pa.sh -w 8 -d 1 --log_file pash.log demo-spell.sh > pash-spell.out
```
```
On our evaluation infrastructure, the 8x-parallel script takes about 14s.

To view the parallel code emitted by the compiler, you can inspect the log:
Expand Down Expand Up @@ -163,12 +163,12 @@ This section includes pointers for further exploration, depending on your needs.
#### The PaSh Repo
PaSh consist of three main components and a few additional "auxiliary" files and directories.
PaSh consist of three main components and a few additional "auxiliary" files and directories.
The three main components are:
* [annotations](../../annotations/): DSL characterizing commands, parallelizability study, and associated annotations. More specifically, (i) a lightweight annotation language allows command developers to express key parallelizability properties about their commands; (ii) an accompanying parallelizability study of POSIX and GNU commands. guides the annotation language and optimized aggregator library
* [annotations](../../annotations/): DSL characterizing commands, parallelizability study, and associated annotations. More specifically, (i) a lightweight annotation language allows command developers to express key parallelizability properties about their commands; (ii) an accompanying parallelizability study of POSIX and GNU commands. guides the annotation language and optimized aggregator library
* [compiler](../../compiler): Shell-dataflow translations and associated parallelization transformations. Given a script, the PaSh compiler converts it to a dataflow graph, performs a series of semantics-preserving program transformations that expose parallelism, and then converts the dataflow graph back into a POSIX script.
* [compiler](../../compiler): Shell-dataflow translations and associated parallelization transformations. Given a script, the PaSh compiler converts it to a dataflow graph, performs a series of semantics-preserving program transformations that expose parallelism, and then converts the dataflow graph back into a POSIX script.
* [runtime](../../runtime): Runtime components such as `eager`, `split`, and associated combiners. Apart from POSIX constructs added to guide parallelism explicitly, PaSh provides Unix-aware runtime primitives for addressing performance- and correctness-related issues.
Expand All @@ -190,7 +190,7 @@ Chat:
* [Discord Server](https://discord.com/channels/947328962739187753/) ([Invite](http://join.binpa.sh/))
Mailing Lists:
Mailing Lists:
* [Discussion](https://groups.google.com/g/pash-dev): Join this mailing list for discussing all things `pash`
* [Commits](https://groups.google.com/g/pash-commits): Join this mailing list for commit notifications
Expand Down

0 comments on commit bb90e0a

Please sign in to comment.