Commit 8b93481b authored by Jeremy Soller's avatar Jeremy Soller

Merge branch 'moveToGitLab' into 'master'

Update links to point to GitLab where possible

See merge request redox-os/book!132
parents 9ae51da4 dec90abd
......@@ -104,7 +104,7 @@
- [Reddit](./contributing/communication/reddit.md)
- [Direct contributions](./contributing/direct_contributions/index.md)
- [Low hanging fruit](./contributing/direct_contributions/low_hanging_fruit.md)
- [GitHub issues](./contributing/direct_contributions/github_issues.md)
- [GitLab issues](./contributing/direct_contributions/gitlab_issues.md)
- [How to do a bug report correctly](./contributing/direct_contributions/creating_proper_bug_reports.md)
- [Pull requests](./contributing/direct_contributions/pull_requests.md)
- [How to do a pull request properly](./contributing/direct_contributions/creating_proper_pull_requests.md)
......
......@@ -4,4 +4,4 @@
* Try to remove useless duplicate/merge commits from PRs as these clutter up history, and may make it hard to read.
* Usually, when syncing your local copy with the master branch, you will want to rebase instead of merge. This is because it will create duplicate commits that don't actually do anything when merged into the master branch.
* When you start to make changes, you will want to create a separate branch, and keep the `master` branch of your fork identical to the main repository, so that you can compare your changes with the main branch and test out a more stable build if you need to.
* You should have a fork of the repository on GitHub and a local copy on your computer. The local copy should have two remotes; `upstream` and `origin`, `upstream` should be set to the main repository and `origin` should be your fork.
* You should have a fork of the repository on GitLab and a local copy on your computer. The local copy should have two remotes; `upstream` and `origin`, `upstream` should be set to the main repository and `origin` should be your fork.
......@@ -11,8 +11,8 @@
* `qemu-system-x86_64 -version` or your actual hardware specs, if applicable
* The operating system you used to build Redox
* `uname -a` or an alternative format
4. Make sure that your bug doesn't already have an issue on GitHub. If you submit a duplicate, you should accept that you may be ridiculed for it, though you'll still be helped. Feel free to ask in the Redox [chat](./contributing/communication/chat.html) if you're uncertain as to whether your issue is new
5. Create a GitHub issue following the template
4. Make sure that your bug doesn't already have an issue on GitLab. If you submit a duplicate, you should accept that you may be ridiculed for it, though you'll still be helped. Feel free to ask in the Redox [chat](./contributing/communication/chat.html) if you're uncertain as to whether your issue is new
5. Create a GitLab issue following the template
* Non-bug report issues may ignore this template
6. Watch the issue and be available for questions
7. Success!
......
......@@ -4,14 +4,14 @@ The steps given below are for the main Redox project - submodules and other proj
1. Clone the original repository to your local PC using one of the following commands based on the protocol you are using:
* HTTPS: `git clone https://github.com/redox-os/redox.git --origin upstream --recursive`
* SSH: `git clone git@github.com:redox-os/redox.git --origin upstream --recursive`
* HTTPS: `git clone https://gitlab.redox-os.org/redox-os/redox.git --origin upstream --recursive`
* SSH: `git clone git@gitlab.redox-os.org:redox-os/redox.git --origin upstream --recursive`
* Use HTTPS if you don't know which one to use. (Recommended: learn about SSH if you don't want to have to login every time you push/pull!)
2. Then rebase to ensure you're using the latest changes: `git rebase upstream master`
3. Fork the repository
4. Add your fork to your list of git remotes with
* HTTPS: `git remote add origin https://github.com/your-username/redox.git`
* SSH: `git remote add origin git@github.com:your-username/redox.git`
* HTTPS: `git remote add origin https://gitlab.redox-os.org/your-username/redox.git`
* SSH: `git remote add origin git@gitlab.redox-os.org:your-username/redox.git`
5. Alternatively, if you already have a fork and copy of the repo, you can simply check to make sure you're up-to-date
* Fetch the upstream:`git fetch upstream master`
* Rebase with local commits:`git rebase upstream/master`
......@@ -19,7 +19,7 @@ The steps given below are for the main Redox project - submodules and other proj
6. Optionally create a separate branch (recommended if you're making multiple changes simultaneously) (`git checkout -b my-branch`)
7. Make changes
8. Commit (`git add . --all; git commit -m "my commit"`)
9. Optionally run [rustfmt](https://github.com/rust-lang-nursery/rustfmt) on the files you changed and commit again if it did anything (check with `git diff` first)
9. Optionally run [rustfmt](https://gitlab.redox-os.org/rust-lang-nursery/rustfmt) on the files you changed and commit again if it did anything (check with `git diff` first)
10. Test your changes with `make qemu` or `make virtualbox` (you might have to use `make qemu kvm=no`, formerly `make qemu_no_kvm`)
(see [Best Practices and Guidelines](./contributing/best_practices/overview.html))
11. Pull from upstream (`git fetch upstream; git rebase upstream/master`) (Note: try not to use `git pull`, it is equivalent to doing `git fetch upstream; git merge master upstream/master`, which is not usually preferred for local/fork repositories, although it is fine in some cases.)
......
# GitHub Issues
# GitLab Issues
GitHub issues are a somewhat formal way to communicate with fellow Redox devs, but a little less quick and convenient than the chat. Issues are a good way to discuss specific topics, but if you want a quick response, using the chat is probably better.
GitLab issues are a somewhat formal way to communicate with fellow Redox devs, but a little less quick and convenient than the chat. Issues are a good way to discuss specific topics, but if you want a quick response, using the chat is probably better.
If you haven't requested to join the chat yet, you should (if at all interested in contributing)!
......@@ -6,14 +6,14 @@ If you're not fluent in Rust:
* Writing documentation
* Using/testing Redox, filing issues for bugs and needed features
* Web development ([Redox website, separate repo](https://github.com/redox-os/website))
* Web development ([Redox website, separate repo](https://gitlab.redox-os.org/redox-os/website))
* Writing unit tests (may require minimal knowledge of rust)
If you are fluent in Rust, but not OS Development:
* Apps development
* Shell ([Ion](https://github.com/redox-os/ion)) development
* Package manager ([pkgutils](https://github.com/redox-os/pkgutils)) development
* Shell ([Ion](https://gitlab.redox-os.org/redox-os/ion)) development
* Package manager ([pkgutils](https://gitlab.redox-os.org/redox-os/pkgutils)) development
* Other high-level code tasks
If you are fluent in Rust, and have experience with OS Dev:
......
......@@ -5,11 +5,11 @@ Redox can run programs. Some programs are interpreted by a runtime for the progr
* In Redox compiled binaries use the standard [ELF](https://en.wikipedia.org/wiki/Executable_and_Linkable_Format) ("Executable and Linkable Format") format.
Programs could directly invoke Redox syscalls, but most call library functions that are higher-level and more comfortable to use. You link your program with the libraries it needs.
* Redox does not support dynamic-link libraries yet ([issue #927](https://github.com/redox-os/redox/issues/927)), so the libraries that a program uses are statically linked into its compiled binary.
* Redox does not support dynamic-link libraries yet ([issue #927](https://gitlab.redox-os.org/redox-os/redox/issues/927)), so the libraries that a program uses are statically linked into its compiled binary.
* Most C and C++ programs call functions in a [C standard library](https://en.wikipedia.org/wiki/C_standard_library) ("libc") such as `fopen`
* Redox includes a port of the newlib Standard C library. This is how programs such as git can run on Redox. newlib has some POSIX compatibility.
* Rust programs implicitly or explicitly call functions in the Rust standard library (libstd).
* ?? ~~Redox implements a subset of this in libredox~~
* The Rust libstd now includes an implementation of its system-dependent parts (such as file access and setting environment variables) for Redox, in `src/libstd/sys/redox`. ?? Most of libstd works in Redox, so many command-line Rust programs can be compiled for Redox.
The Redox ["cookbook" project](https://github.com/redox-os/cookbook) includes recipes for compiling C and Rust projects into Redox binaries.
The Redox ["cookbook" project](https://gitlab.redox-os.org/redox-os/cookbook) includes recipes for compiling C and Rust projects into Redox binaries.
......@@ -39,4 +39,4 @@ Note
If you encounter any bugs, errors, obstructions, or other annoying things, please report the issue to the [Redox repository]. Thanks!
[Redox repository]: https://github.com/redox-os/redox
[Redox repository]: https://gitlab.redox-os.org/redox-os/redox
......@@ -24,7 +24,7 @@ sudo apt install x86-64-unknown-redox-gcc
To install the toolchain, run the following commands:
```bash
# Clone libc
git clone --recursive git@github.com:redox-os/libc
git clone --recursive git@gitlab.redox-os.org:redox-os/libc
# Go to the packages
cd libc/packages/arch
......@@ -54,7 +54,7 @@ To install the toolchain, run the following commands:
To install the toolchain, run the following commands:
```bash
# Clone libc
git clone --recursive git@github.com:redox-os/libc
git clone --recursive git@gitlab.redox-os.org:redox-os/libc
# Run the setup script
cd libc
......
......@@ -9,10 +9,10 @@ Using the bootstrap Script
If you're on a Linux or macOS computer, you can just run the bootstrapping script, which does the build preparation for you. Change to the folder where you want the source code to live and run the following command:
```sh
$ curl -sf https://raw.githubusercontent.com/redox-os/redox/master/bootstrap.sh -o bootstrap.sh && bash -e bootstrap.sh
$ curl -sf https://gitlab.redox-os.org/redox-os/redox/raw/master/bootstrap.sh -o bootstrap.sh && bash -e bootstrap.sh
```
This script fetches build dependencies using a package manager for your platform and clones the Redox code from GitHub. It checks whether you might already have a dependency and skips the installation in this case. On some systems this is simply done by checking whether the binary exists and doesn't take into account which version of the program you have. This can lead to build errors if you have old versions already installed. In this case, please install the skipped dependencies manually.
This script fetches build dependencies using a package manager for your platform and clones the Redox code from GitLab. It checks whether you might already have a dependency and skips the installation in this case. On some systems this is simply done by checking whether the binary exists and doesn't take into account which version of the program you have. This can lead to build errors if you have old versions already installed. In this case, please install the skipped dependencies manually.
Manual Setup
------------
......@@ -22,7 +22,7 @@ Manual Setup
Change to the folder where you want your copy of Redox to be stored and issue the following command:
```sh
$ git clone https://github.com/redox-os/redox.git --origin upstream --recursive && \
$ git clone https://gitlab.redox-os.org/redox-os/redox.git --origin upstream --recursive && \
cd redox && git submodule update --recursive --init
```
......
......@@ -3,7 +3,7 @@ Running Redox on real hardware
Currently, Redox only natively supports booting from a hard disk with no partition table. Therefore, the current ISO image uses a bootloader to load the filesystem into memory and emulates one. This is inefficent and requires a somewhat large amount of memory, which will be fixed once proper support for various things (such as a USB mass storage driver) are implemented.
Despite the awkward way it works, the ISO image is the recomended way to try out Redox on real hardware (in an emulator, a virtual hard drive is better). You can obtain an ISO image either by downloading the [latest release](https://github.com/redox-os/redox/releases), or by building one with `make iso` from the [Redox source tree](https://github.com/redox-os/redox).
Despite the awkward way it works, the ISO image is the recomended way to try out Redox on real hardware (in an emulator, a virtual hard drive is better). You can obtain an ISO image either by downloading the [latest release](https://gitlab.redox-os.org/redox-os/redox/releases), or by building one with `make iso` from the [Redox source tree](https://gitlab.redox-os.org/redox-os/redox).
You can create a bootable CD or USB drive from the ISO as with other bootable disk images.
......
......@@ -3,7 +3,7 @@ Trying Redox in a virtual machine
The ISO image is *not* the prefered way to run Redox in a virtual machine. Currently the ISO image loads the entire hard disk image (including unused space) into memory. In the future, the live disk should be improved so that doesn't happen.
Instead, you want to use the hard disk image, which you can find on the [release pages](https://github.com/redox-os/redox/releases) as a `.bin.gz` file. Download and extract that file.
Instead, you want to use the hard disk image, which you can find on the [release pages](https://gitlab.redox-os.org/redox-os/redox/tags) as a `.bin.gz` file. Download and extract that file.
You can then run it in your prefered emulator; this command will run qemu with various features Redox can use enables:
......
About this Book
===============
This book is written in [Markdown], built using [mdBook]. The source files can be found (and forked) on GitHub at [github.com/redox-os/book/].
This book is written in [Markdown], built using [mdBook]. The source files can be found (and forked) on GitLab at [gitlab.redox-os.org/redox-os/book/].
[Markdown]: http://daringfireball.net/projects/markdown/basics
[mdBook]: https://github.com/azerupi/mdBook
[github.com/redox-os/book/]: https://github.com/redox-os/book/
[gitlab.redox-os.org/redox-os/book/]: https://gitlab.redox-os.org/redox-os/book/
......@@ -52,4 +52,4 @@ We have to admit, that we do like the idea of writing something that is our own
[jails]: https://www.freebsd.org/doc/handbook/jails.html
[ZFS]: https://www.freebsd.org/doc/handbook/zfs.html
[reliability]: http://wiki.minix3.org/doku.php?id=www:documentation:reliability
[TFS]: https://github.com/redox-os/tfs
[TFS]: https://gitlab.redox-os.org/redox-os/tfs
......@@ -3,7 +3,7 @@ The Redox community
We are quite a few developers at Redox. 40+ people work on it. There are all sorts of cool people to work with.
The "core team" (people who are members of the [GitHub organization](https://github.com/redox-os)) is currently:
The "core team" (people who are members of the [GitLab organization](https://gitlab.redox-os.org/redox-os)) is currently:
(alphabetically sorted)
......@@ -42,28 +42,28 @@ But [don't]. [forget]. [all]. [the]. [other]. [awesome]. [contributors].
[batonius]: https://github.com/batonius
[ca1ek]: https://github.com/ca1ek
[cwood1]: https://github.com/cwood1
[dlrobertson]: https://github.com/dlrobertson
[dlrobertson]: https://gitlab.redox-os.org/dlrobertson
[hauleth]: https://github.com/hauleth
[ids1024]: https://github.com/ids1024
[jackpot51]: https://github.com/jackpot51
[ids1024]: https://gitlab.redox-os.org/ids1024
[jackpot51]: https://gitlab.redox-os.org/jackpot51
[k0pernicus]: https://github.com/k0pernicus
[mgattozzi]: https://github.com/mgattozzi
[mmstick]: https://github.com/mmstick
[mmstick]: https://gitlab.redox-os.org/mmstick
[movingtomars]: https://github.com/movingtomars
[nounoursheureux]: https://github.com/nounoursheureux
[polymetric1]: https://github.com/polymetric1
[pythoneer]: https://github.com/pythoneer
[sajattack]: https://github.com/sajattack
[sajattack]: https://gitlab.redox-os.org/sajattack
[skylerberg]: https://github.com/skylerberg
[stratact]: https://github.com/stratact
[stratact]: https://gitlab.redox-os.org/stratact
[ticki]: https://github.com/ticki
[this list]: ./overview/maintainers.html
[don't]: https://github.com/redox-os/redox/graphs/contributors
[forget]: https://github.com/redox-os/coreutils/graphs/contributors
[all]: https://github.com/redox-os/sodium/graphs/contributors
[the]: https://github.com/redox-os/ion/graphs/contributors
[other]: https://github.com/redox-os/orbtk/graphs/contributors
[awesome]: https://github.com/redox-os/orbclient/graphs/contributors
[contributors]: https://github.com/redox-os/redox/graphs/contributors
[don't]: https://gitlab.redox-os.org/redox-os/redox/graphs/master
[forget]: https://gitlab.redox-os.org/redox-os/coreutils/graphs/master
[all]: https://gitlab.redox-os.org/redox-os/sodium/graphs/master
[the]: https://gitlab.redox-os.org/redox-os/ion/graphs/master
[other]: https://gitlab.redox-os.org/redox-os/orbtk/graphs/master
[awesome]: https://gitlab.redox-os.org/redox-os/orbclient/graphs/master
[contributors]: https://gitlab.redox-os.org/redox-os/redox/graphs/master
......@@ -25,28 +25,28 @@ Currently, [jackpot51] maintains:
[mmstick] maintains the [Ion Shell].
[jackpot51]: https://github.com/jackpot51
[mmstick]: https://github.com/mmstick
[stratact]: https://github.com/stratact
[ticki]: https://github.com/ticki
[The kernel, drivers, standard library, and Orbital]: https://github.com/redox-os/redox
[The installer]: https://github.com/redox-os/installer
[RedoxFS]: https://github.com/redox-os/redoxfs
[Newlib and C ports]: https://github.com/redox-os/libc
[Orbclient]: https://github.com/redox-os/orbclient
[OrbTK]: https://github.com/redox-os/orbtk
[Orbutils]: https://github.com/redox-os/orbutils
[pkgutils]: https://github.com/redox-os/pkgutils
[Ralloc]: https://github.com/redox-os/ralloc
[Coreutils]: https://github.com/redox-os/coreutils
[Sodium]: https://github.com/redox-os/sodium
[TFS, a next-generation file system]: https://github.com/redox-os/tfs
[Tedsta]: https://github.com/tedsta
[Libextra]: https://github.com/redox-os/libextra
[Binutils]: https://github.com/redox-os/binutils
[Extrautils]: https://github.com/redox-os/extrautils
[The project "Games for Redox"]: https://github.com/redox-os/games
[Ion Shell]: https://github.com/redox-os/ion
[jackpot51]: https://gitlab.redox-os.org/jackpot51
[mmstick]: https://gitlab.redox-os.org/mmstick
[stratact]: https://gitlab.redox-os.org/stratact
[ticki]: https://gitlab.redox-os.org/ticki
[The kernel, drivers, standard library, and Orbital]: https://gitlab.redox-os.org/redox-os/redox
[The installer]: https://gitlab.redox-os.org/redox-os/installer
[RedoxFS]: https://gitlab.redox-os.org/redox-os/redoxfs
[Newlib and C ports]: https://gitlab.redox-os.org/redox-os/libc
[Orbclient]: https://gitlab.redox-os.org/redox-os/orbclient
[OrbTK]: https://gitlab.redox-os.org/redox-os/orbtk
[Orbutils]: https://gitlab.redox-os.org/redox-os/orbutils
[pkgutils]: https://gitlab.redox-os.org/redox-os/pkgutils
[Ralloc]: https://gitlab.redox-os.org/redox-os/ralloc
[Coreutils]: https://gitlab.redox-os.org/redox-os/coreutils
[Sodium]: https://gitlab.redox-os.org/redox-os/sodium
[TFS, a next-generation file system]: https://gitlab.redox-os.org/redox-os/tfs
[Tedsta]: https://gitlab.redox-os.org/tedsta
[Libextra]: https://gitlab.redox-os.org/redox-os/libextra
[Binutils]: https://gitlab.redox-os.org/redox-os/binutils
[Extrautils]: https://gitlab.redox-os.org/redox-os/extrautils
[The project "Games for Redox"]: https://gitlab.redox-os.org/redox-os/games
[Ion Shell]: https://gitlab.redox-os.org/redox-os/ion
......@@ -41,22 +41,22 @@ The first category should be obvious: an OS without certain core tools is a usel
It is important to note we seek to avoid non-Rust tools, for safety and consistency (see [Why Rust]).
[TFS]: https://github.com/redox-os/tfs
[Ion]: https://github.com/redox-os/ion
[Orbital]: https://github.com/redox-os/orbital
[OrbTK]: https://github.com/redox-os/orbtk
[pkgutils]: https://github.com/redox-os/pkgutils
[Sodium]: https://github.com/redox-os/sodium
[ralloc]: https://github.com/redox-os/ralloc
[libextra]: https://github.com/redox-os/libextra
[games-for-redox]: https://github.com/redox-os/games
[here]: https://github.com/redox-os
[Coreutils]: https://github.com/redox-os/coreutils
[Extrautils]: https://github.com/redox-os/extrautils
[Binutils]: https://github.com/redox-os/binutils
[uutils/coreutils]: https://github.com/uutils/coreutils
[m-labs/smoltcp]: https://github.com/m-labs/smoltcp
[TFS]: https://gitlab.redox-os.org/redox-os/tfs
[Ion]: https://gitlab.redox-os.org/redox-os/ion
[Orbital]: https://gitlab.redox-os.org/redox-os/orbital
[OrbTK]: https://gitlab.redox-os.org/redox-os/orbtk
[pkgutils]: https://gitlab.redox-os.org/redox-os/pkgutils
[Sodium]: https://gitlab.redox-os.org/redox-os/sodium
[ralloc]: https://gitlab.redox-os.org/redox-os/ralloc
[libextra]: https://gitlab.redox-os.org/redox-os/libextra
[games-for-redox]: https://gitlab.redox-os.org/redox-os/games
[here]: https://gitlab.redox-os.org/redox-os
[Coreutils]: https://gitlab.redox-os.org/redox-os/coreutils
[Extrautils]: https://gitlab.redox-os.org/redox-os/extrautils
[Binutils]: https://gitlab.redox-os.org/redox-os/binutils
[uutils/coreutils]: https://gitlab.redox-os.org/uutils/coreutils
[m-labs/smoltcp]: https://gitlab.redox-os.org/m-labs/smoltcp
[Why Rust]: ./introduction/why_rust.html
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment