Skip to content

Commit 1e95767

Browse files
olyagplolyagpl
committed
Include YAML headers to user docs
1 parent 09683f1 commit 1e95767

19 files changed

+190
-1
lines changed

‎doc/user/compatibility.md

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,13 @@
1+
---
2+
layout: docs-experimental
3+
toc_group: ruby
4+
title: Compatibility
5+
link_title: Compatibility
6+
permalink: /reference-manual/ruby/Compatibility/
7+
redirect_from: /docs/reference-manual/ruby/Compatibility/
8+
next: /en/graalvm/enterprise/21/docs/reference-manual/ruby/Debugging/
9+
previous: /en/graalvm/enterprise/21/docs/reference-manual/ruby/
10+
---
111
# Compatibility
212

313
TruffleRuby aims to be fully compatible with the standard implementation of

‎doc/user/debugging.md

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,13 @@
1+
---
2+
layout: docs-experimental
3+
toc_group: ruby
4+
title: Debugging Ruby
5+
link_title: Debugging Ruby
6+
permalink: /reference-manual/ruby/Debugging/
7+
redirect_from: /docs/reference-manual/ruby/Debugging/
8+
next: /en/graalvm/enterprise/21/docs/reference-manual/ruby/RuntimeConfigurations/
9+
previous: /en/graalvm/enterprise/21/docs/reference-manual/ruby/Compatibility/
10+
---
111
# Debugging TruffleRuby
212

313
## Printing Exceptions

‎doc/user/deploying.md

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,13 @@
1+
---
2+
layout: docs-experimental
3+
toc_group: ruby
4+
title: Runtime Configurations
5+
link_title: Runtime Configurations
6+
permalink: /reference-manual/ruby/RuntimeConfigurations/
7+
redirect_from: /docs/reference-manual/ruby/RuntimeConfigurations/
8+
next: /en/graalvm/enterprise/21/docs/reference-manual/ruby/InstallingGraalVM/
9+
previous: /en/graalvm/enterprise/21/docs/reference-manual/ruby/Debugging/
10+
---
111
# Deploying TruffleRuby
212

313
If you are attempting to experiment with deploying TruffleRuby to production we would encourage you to contact us so we can help you understand what is possible at the moment and to help solve any issues for you.

‎doc/user/faq.md

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,12 @@
1+
---
2+
layout: docs-experimental
3+
toc_group: ruby
4+
title: FAQ
5+
link_title: FAQ
6+
permalink: /reference-manual/ruby/FAQ/
7+
redirect_from: /docs/reference-manual/ruby/FAQ/
8+
previous: /en/graalvm/enterprise/21/docs/reference-manual/ruby/Optcarrot/
9+
---
110
# Frequently Asked Questions
211

312
### What is TruffleRuby?

‎doc/user/installing-graalvm.md

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,13 @@
1+
---
2+
layout: docs-experimental
3+
toc_group: ruby
4+
title: Using Ruby with GraalVM
5+
link_title: Using Ruby with GraalVM
6+
permalink: /reference-manual/ruby/InstallingGraalVM/
7+
redirect_from: /docs/reference-manual/ruby/InstallingGraalVM/
8+
next: /en/graalvm/enterprise/21/docs/reference-manual/ruby/Installinglibssl/
9+
previous: /en/graalvm/enterprise/21/docs/reference-manual/ruby/RuntimeConfigurations/
10+
---
111
# Using TruffleRuby with GraalVM
212

313
[GraalVM](http://graalvm.org/) is the platform on which TruffleRuby runs.

‎doc/user/installing-libssl.md

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,13 @@
1+
---
2+
layout: docs-experimental
3+
toc_group: ruby
4+
title: Installing `libssl`
5+
link_title: Installing `libssl`
6+
permalink: /reference-manual/ruby/Installinglibssl/
7+
redirect_from: /docs/reference-manual/ruby/Installinglibssl/
8+
next: /en/graalvm/enterprise/21/docs/reference-manual/ruby/InstallingLLVM/
9+
previous: /en/graalvm/enterprise/21/docs/reference-manual/ruby/InstallingGraalVM/
10+
---
111
# Installing `libssl`
212

313
TruffleRuby provides the `openssl` module but not the native `libssl` system library that the module uses.

‎doc/user/installing-llvm.md

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,13 @@
1+
---
2+
layout: docs-experimental
3+
toc_group: ruby
4+
title: Installing Make and GCC
5+
link_title: Installing Make and GCC
6+
permalink: /reference-manual/ruby/InstallingLLVM/
7+
redirect_from: /docs/reference-manual/ruby/InstallingLLVM/
8+
next: /en/graalvm/enterprise/21/docs/reference-manual/ruby/Installingzlib/
9+
previous: /en/graalvm/enterprise/21/docs/reference-manual/ruby/Installinglibssl/
10+
---
111
# Installing Make and GCC
212

313
Since TruffleRuby 19.3.0, TruffleRuby ships with its own LLVM toolchain.

‎doc/user/installing-zlib.md

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,13 @@
1+
---
2+
layout: docs-experimental
3+
toc_group: ruby
4+
title: Installing `zlib`
5+
link_title: Installing `zlib`
6+
permalink: /reference-manual/ruby/Installingzlib/
7+
redirect_from: /docs/reference-manual/ruby/Installingzlib/
8+
next: /en/graalvm/enterprise/21/docs/reference-manual/ruby/JRubyMigration/
9+
previous: /en/graalvm/enterprise/21/docs/reference-manual/ruby/InstallingLLVM/
10+
---
111
# Installing `zlib`
212

313
TruffleRuby provides the `zlib` module but not the native `zlib` system library that the module uses.

‎doc/user/jruby-migration.md

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,13 @@
1+
---
2+
layout: docs-experimental
3+
toc_group: ruby
4+
title: Migration from JRuby to Ruby
5+
link_title: Migration from JRuby to Ruby
6+
permalink: /reference-manual/ruby/JRubyMigration/
7+
redirect_from: /docs/reference-manual/ruby/JRubyMigration/
8+
next: /en/graalvm/enterprise/21/docs/reference-manual/ruby/Options/
9+
previous: /en/graalvm/enterprise/21/docs/reference-manual/ruby/Installingzlib/
10+
---
111
# Migration from JRuby to TruffleRuby
212

313
When trying TruffleRuby on your gems and applications, you are encouraged to [get in touch with the TruffleRuby team](../../README.md#contact) for help.

‎doc/user/known-cves.md

Lines changed: 11 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,13 @@
1+
---
2+
layout: docs-experimental
3+
toc_group: ruby
4+
title: Security
5+
link_title: Security
6+
permalink: /reference-manual/ruby/KnownCVEs/
7+
redirect_from: /docs/reference-manual/ruby/KnownCVEs/
8+
next: /en/graalvm/enterprise/21/docs/reference-manual/ruby/Optcarrot/
9+
previous: /en/graalvm/enterprise/21/docs/reference-manual/ruby/ReportingPerformanceProblems/
10+
---
111
# Security
212

313
Please report security vulnerabilities via the process outlined in the [reporting vulnerabilities guide](https://www.oracle.com/corporate/security-practices/assurance/vulnerability/reporting.html).
@@ -28,7 +38,7 @@ Cross-reference with the details on [the MRI website](https://www.ruby-lang.org/
2838
Number | Description | Their Mitigation | Test | Our Mitigation
2939
--- | --- | --- | --- | ---
3040
CVE-2021-28966 | Path traversal in Tempfile on Windows | Sanitization of paths in tmpdir.rb | In `test/mri/tests/test_tmpdir.rb` | Sanitization of paths in tmpdir.rb
31-
CVE-2021-28965 | XML round-trip vulnerability in REXML | Update to REXML 3.2.5 | In ruby/rexml | Update to REXML 3.2.5
41+
CVE-2021-28965 | XML round-trip vulnerability in REXML | Update to REXML 3.2.5 | In ruby/rexml | Update to REXML 3.2.5
3242
CVE-2020-10663 | Unsafe Object Creation Vulnerability in JSON (Additional fix) | [Fix](https://bugs.ruby-lang.org/issues/16698) | [Spec](https://github.com/ruby/spec/pull/764) | The pure Ruby version of JSON we use is safe
3343
CVE-2019-16255 | A code injection vulnerability of Shell#[] and Shell#test | [Fix](https://github.com/ruby/ruby/commit/d6adc68dc9c74a33b3ca012af171e2d59f0dea10) | MRI test | Same
3444
CVE-2019-16254 | HTTP response splitting in WEBrick (Additional fix) | [Fix](https://github.com/ruby/ruby/commit/3ce238b5f9795581eb84114dcfbdf4aa086bfecc) | MRI test | Same

0 commit comments

Comments
 (0)