1berry/ruby
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity
91,898 Commits 27 Branches 1,171 Tags
Commit Graph

88 Commits

Author SHA1 Message Date
Stan Lo
ab22f3910d Mention VS Code debugger configuration in debugging guide 2025-04-18 13:56:57 +09:00
Burdette Lamar
765918d283
[DOC] Tweaks for docs about contributing (#13012) 2025-03-31 14:48:23 -04:00
Edouard CHIN
366462bd46 - Add a mention to git 2.32 in the building ruby documentation: 
I had issues building Ruby as I was using git 2.30.
  The error was:

  > file2lastrev.rb: git rev-parse failed error: could not expand
  > include path '~/.gitcinclude'

  The default system git config includes paths making use of `$HOME`,
  but that env variable gets removed when building: 7070b1b196/tool/lib/vcs.rb (L546-L547)

  It works with git `>= 2.32` thanks to the `GIT_CONFIG_SYSTEM`
  feature which gets set to a Null IO in order to override
  the system gitconfig. 7070b1b196/tool/lib/vcs.rb (L549)
 2025-01-31 11:52:57 +09:00
Nobuyoshi Nakada
32cb4b204d
[DOC] Link to MarkupReference directly 2025-01-16 14:03:45 +09:00
Nobuyoshi Nakada
e433e6515e
[DOC] Exclude 'Class' and 'Module' from RDoc's autolinking 2025-01-02 12:36:06 +09:00
Alexander Momchilov
8cc47c9050
Improve "Building Ruby" docs (#12320) 
* Clarify “Building Ruby” docs

* Fix test examples to work from `build` dir

* Clarify “Testing Ruby” examples with real examples

All the commands should run correctly by default, without the user needing to modify them. This builds confidence that the relative paths are working correct from within the `build` directory.

Also, let’s use a consistent example throughout, for greater clarity.

* Improve examples to use `-v` flag in-context

This shows the correct way to combine `-v` with another parameter, e.g. a specific file to test.

* Other readability improvements

* Clarify `make` implementation support
 2024-12-12 17:55:23 -08:00
Alexander Momchilov
0ea5c13bc6
[DOC] Improve formatting in Markdown files (#12322) 
* Fix WASM bullet/code indentation

* Use `console` code highlighting where appropriate

… which handles the prefix `$` correctly.

* Migrate feature proposal template to MarkDown

* Set language on code blocks
 2024-12-12 17:49:45 -08:00
Nobuyoshi Nakada
a7d510808d
[DOC] --with-opt-dir options and CONFIGURE_ARGS 2024-11-12 11:37:16 +09:00
BurdetteLamar
b9902c94a3 Adds remarks about returned Enumerator 2024-08-23 16:21:40 -04:00
BurdetteLamar
e008f0553d [DOC] Add remark about in-brief for method doc 2024-08-08 16:08:47 -04:00
Burdette Lamar
f5d193d525
[DOC] Adds "Further Considerations" to documentation_guide.md (#11281) 2024-07-31 16:09:15 -04:00
BurdetteLamar
df1cc04301 Add remark about call-seq 2024-07-29 09:15:19 -04:00
cdfzo
087b461c83
[DOC] Fix typo with -> wish 2024-07-07 13:09:42 +09:00
Nobuyoshi Nakada
1f8c45aa51
[DOC] building_ruby: Move the caution to a footnote 2024-06-02 21:33:02 +09:00
Nobuyoshi Nakada
7e52e3e3f7
[DOC] building_ruby: External library links 
- `OpenSSL` here is not the class.
- libexecinfo on FreeBSD is present in the base system of all
  supported releases, since 2017.
 2024-06-02 21:33:02 +09:00
Nobuyoshi Nakada
457c6b4789
[DOC] building_ruby: Refine links 
Get rid of using ambiguous demonstratives as link anchors, for the
accessibility's sake.
 2024-06-02 21:33:02 +09:00
Nobuyoshi Nakada
5980f14e88
[DOC] building_ruby: Fold long lines 2024-06-02 21:33:01 +09:00
Nobuyoshi Nakada
3eba84fba0
[DOC] Caution about old GNU make 2024-06-02 19:59:05 +09:00
KJ Tsanaktsidis
fd2876e6a2 Update ASAN docs to refer to Clang 18's release 
Clang 18 has the bugfix we need, so we no longer need to tell people to
compile Clang from source.
 2024-05-10 10:55:28 +10:00
Hiroshi SHIBATA
7e8d8f250d
Removed obsoleted section because make docs is removed from default make task 2024-04-24 17:19:04 +09:00
Hiroshi SHIBATA
945a0334c7 Update build and install document related https://blade.ruby-lang.org/ruby-dev/39325 2024-04-17 19:56:20 +09:00
KJ Tsanaktsidis
e02a06fbf2 Document how to run the tests under ASAN now that they pass! 2024-03-31 21:12:31 +11:00
John Hawthorn
b8572c3f16 BASERUBY is now >= 3.0 2024-02-26 14:03:49 -08:00
ydah
303852440a s/bellow/below/ 2024-02-15 17:01:02 +09:00
KJ Tsanaktsidis
1f0fa31834 Fix typo in asan section of building_ruby.md docs 
s/copmiler-rt/compiler-rt/
 2024-02-13 10:07:04 +09:00
Burdette Lamar
4f1a466522
More on auto-link (#9907) 2024-02-12 15:01:46 -05:00
KJ Tsanaktsidis
697ade7bda Update ASAN docs to reflect the current state of things 
I don't really think ASAN works well at all on any version of Ruby from
before https://bugs.ruby-lang.org/issues/20001 was landed. Update the
docs to clarify what works, and what does not work.

Also there's no need to compile at `-O0`; this was probably just hiding
some of the problems with our stack scanning that were fixed in the
above issue.

[Bug #20248]
 2024-02-12 10:52:05 +11:00
Kazuhiro NISHIYAMA
42177a8987
[DOC] Update ruby version in Building Ruby Dependencies 2024-01-18 08:45:09 +09:00
Hiroshi SHIBATA
c903cddf55
Typofix under doc directory 2023-12-25 11:17:51 +09:00
Burdette Lamar
715cf9b690
[DOC] More on What's Here (#9099) 
* More on What's Here

* More on What's Here
 2023-12-02 11:46:57 -06:00
Burdette Lamar
12f4e9655e
Add recommendations on link formatting in documentation 2023-11-23 20:39:24 -08:00
Takashi Kokubun
ee25ac49f3 [DOC] Use a relative link like other links 
following up on https://github.com/ruby/ruby/pull/8832
 2023-11-06 09:46:37 -08:00
JorandeBoer
a763d085e4 Updated building_ruby.md to include reference for building on Windows 
Looking at building_ruby.md it is unclear that you are able to build Ruby on Windows. To fix that a reference has been added to the windows.md file.
 2023-11-06 11:52:31 +09:00
Nobuyoshi Nakada
0061eaddc9
[DOC] configure -C tips 2023-10-20 16:33:23 +09:00
Matheus Richard
72f97ee06e
[DOC] Improve docs for how to generate documentation 
It might not be obvious how to get the build directory and the Makefile
set up.
 2023-10-20 08:45:07 +09:00
Jun Aruga
13dafb210e [DOC] testing_ruby.md: Add spec/ for the explanation of the make check. 2023-10-14 22:43:41 -07:00
Jun Aruga
df1887414a [DOC] testing_ruby.md: Remove the command prompt '$ ` aligning with other parts. 
Remove the command prompt '$ ` aligning with other parts in the document.
 2023-10-14 22:43:41 -07:00
Jun Aruga
6c952ac600
testing_ruby.md: Document running test suites on s390x CPU architecture [ci skip] (#8589) 2023-10-09 17:05:51 +02:00
Burdette Lamar
36cd2b2a52
[DOC] Correction for doc guide + TOC fix in File (#8505) 2023-09-24 17:57:21 -04:00
Samuel Williams
b2d1c720ec
Add documentation regarding how to build Ruby for debugging. (#8290) 
Co-authored-by: Nobuyoshi Nakada <nobu@ruby-lang.org>
 2023-08-26 09:59:45 +12:00
Burdette Lamar
448ff162c4
[DOC] Adding font usage to doc guide (#8255) 2023-08-23 10:09:24 -04:00
Nobuyoshi Nakada
6ebde04202
[DOC] Update to use SPECOPTS instead of MSPECOPT 2023-08-12 12:33:05 +09:00
Burdette Lamar
6ccc660d85
[DOC] Don't suppress autolinks (#8207) 2023-08-11 17:53:53 -04:00
jinroq
ebb7552e6d
[Doc] Make build instructions easier to copy-and-paste 2023-07-14 12:52:33 -04:00
Burdette Lamar
6528cf9fcf
[DOC] Fixes for link fragments (#7981) 2023-06-28 09:05:43 -04:00
Nobuyoshi Nakada
dc940cc740
[DOC] Nested ordered lists need more indents 2023-06-26 18:25:21 +09:00
BurdetteLamar
ed587abffb Fix broken links 2023-06-25 16:44:59 -04:00
Jun Aruga
6d450d62fb testing_ruby.md: Update make test-all tips [ci skip] 2023-05-26 09:19:38 -04:00
Yuichiro Kaneko
a1b01e7701
Use Lrama LALR parser generator instead of Bison 
https://bugs.ruby-lang.org/issues/19637

Co-authored-by: Nobuyoshi Nakada <nobu@ruby-lang.org>
 2023-05-12 18:25:10 +09:00
Hiroshi SHIBATA
172077232e
readline or libedit is no longer required to build ruby 2023-05-10 09:55:27 +09:00