tonyair/silverstripe-framework
1
0
Fork 0
mirror of https://github.com/silverstripe/silverstripe-framework synced 2024-10-22 14:05:37 +02:00
Code Issues Projects Releases Wiki Activity

Merge pull request #7513 from dhensby/pulls/4.0/sake-location-docs

Browse Source 
DOCS Update sake location where relevant
This commit is contained in:
Ingo Schommer 2017-10-26 09:09:39 +13:00 committed by GitHub
commit f006ef6354
2 changed files with 8 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
docs/en/02_Developer_Guides/14_Files/05_File_Migration.md
View File

@ -13,7 +13,7 @@ has been added to assist in migration of legacy files.
You can run this task on the command line: You can run this task on the command line:
``` ```
$ ./vendor/silverstripe/framework/sake dev/tasks/MigrateFileTask $ ./vendor/bin/sake dev/tasks/MigrateFileTask
``` ```
This task will also support migration of existing File DataObjects to file versioning. Any This task will also support migration of existing File DataObjects to file versioning. Any

14
docs/en/02_Developer_Guides/17_CLI/index.md
View File

@ -23,7 +23,7 @@ to have.
## Sake - SilverStripe Make ## Sake - SilverStripe Make
Sake is a simple wrapper around `cli-script.php`. It also tries to detect which `php` executable to use if more than one Sake is a simple wrapper around `cli-script.php`. It also tries to detect which `php` executable to use if more than one
are available. are available. It is accessible via `vendor/bin/sake`.
<div class="info" markdown='1'> <div class="info" markdown='1'>
If you are using a Debian server: Check you have the php-cli package installed for sake to work. If you get an error If you are using a Debian server: Check you have the php-cli package installed for sake to work. If you get an error
@ -32,10 +32,10 @@ when running the command php -v, then you may not have php-cli installed so sake
### Installation ### Installation
`sake` can be invoked using `./vendor/silverstripe/framework/sake`. For easier access, copy the `sake` file into `/usr/bin/sake`. `sake` can be invoked using `./vendor/bin/sake`. For easier access, copy the `sake` file into `/usr/bin/sake`.
``` ```
cd your-webroot/ cd your-webroot/
sudo ./vendor/silverstripe/framework/sake installsake sudo ./vendor/bin/sake installsake
``` ```
<div class="warning"> <div class="warning">
This currently only works on UNIX like systems, not on Windows. This currently only works on UNIX like systems, not on Windows.
@ -55,7 +55,7 @@ SS_BASE_URL="http://localhost/base-url"
### Usage ### Usage
Sake can run any controller by passing the relative URL to that controller. `sake` can run any controller by passing the relative URL to that controller.
```bash ```bash
@ -67,7 +67,7 @@ Sake can run any controller by passing the relative URL to that controller.
# shows a list of development operations # shows a list of development operations
``` ```
Sake is particularly useful for running build tasks. `sake` is particularly useful for running build tasks.
```bash ```bash
sake dev/build "flush=1" sake dev/build "flush=1"
@ -86,7 +86,7 @@ It can also be handy if you have a long running script..
Make a task or controller class that runs a loop. To avoid memory leaks, you should make the PHP process exit when it Make a task or controller class that runs a loop. To avoid memory leaks, you should make the PHP process exit when it
hits some reasonable memory limit. Sake will automatically restart your process whenever it exits. hits some reasonable memory limit. Sake will automatically restart your process whenever it exits.
Include some appropriate sleep()s so that your process doesn't hog the system. The best thing to do is to have a short Include some appropriate `sleep()`s so that your process doesn't hog the system. The best thing to do is to have a short
sleep when the process is in the middle of doing things, and a long sleep when doesn't have anything to do. sleep when the process is in the middle of doing things, and a long sleep when doesn't have anything to do.
This code provides a good template: This code provides a good template:
@ -158,5 +158,5 @@ On a UNIX machine, you can typically run a scheduled task with a [cron job](http
The following will run `MyTask` every minute. The following will run `MyTask` every minute.
```bash ```bash
* * * * * /your/site/folder/sake dev/tasks/MyTask * * * * * /your/site/folder/vendor/bin/sake dev/tasks/MyTask
``` ```